Installation

Install with pip

You should install SciAssist in a virtual environment. If you’re unfamiliar with Python virtual environments, take a look at this guide:

First, creating a virtual environment in your project directory:

python -m venv .env

Activate the virtual environment. On Linux and MacOs:

source .env/bin/activate

On Windows:

.env/Scripts/activate

Option:

You may need to install pytorch according to instructions.

Now you’re ready to install SciAssist with pip:

pip install SciAssist

Setup Grobid for pdf processing (Only for Linux)

If you want to process pdf files with Grobid server, then you need to install it first.

Note

Grobid is not available for Windows. So we use pyminer.six to process pdfs on Windows, and Windows users can skip the following part. For Linux and MacOs, we use Grobid by default.

You will need to have Java installed on your machine. Then, you can install your own version of Grobid and get it running. After you install the package, you can simply setup grobid with the CLI:

setup_grobid

This will setup Grobid. And after installation, starts the Grobid server with:

run_grobid

Now you are ready for inference on your task.