Install for Python

Install for Python#

Required Tools#

To use ScisTree2, you will need the following tools and libraries installed:

  • python & pip: Version 3.6 or higher.

  • g++: A C++ compiler. (from source only)

  • make: For building the backend. (from source only)

Note

We have successfully tested it on Linux, macOS, and Windows (via WSL).

Installation#

1. Install from PyPI:#

  1. Upgrade pip:

    python -m pip install --upgrade pip

  2. Install scistree2:

    pip install scistree2

2. Install from source:#

  1. Clone the repository:

    git clone https://github.com/yufengwudcs/ScisTree2.git
cd scistree2

  2. Install the Python package (includes C++ backend compilation): You can install the scistree2 package using pip:

    pip install .

    This command will also automatically compile the C++ backend. Once built, the executable binary file can be found in scistree2/bin.

    Note

    We recommend that users create a virtual environment using either conda or venv to comply with PEP 668.

Contents