NOTAE Tools

Install and run the API server

1. First, make sure that you have the source code by downloading it and unzipping it, or by cloning it from the repository. Then, change directory to the source code root.

cd notaetools

2. Second, create a new environment for installing dependencies and required packages.

conda env create -f environment.yml

3. Third, activate the environment. For example, if the name of the environment from the previous step is notaetools then proceed as follows:

conda activate notaetools

In order to verify that it's been activated look at the command line. On the left there should be the name of the environment in parantheses.

4. Update the environement from the environment.yml file like this:

conda env update --file environment.yml --prune

5. Finally, run the server for serving the computer vision model through the REST API

python api.py

Creating an environment from an environment.yml file

Use the terminal or an Anaconda Prompt for the following steps:

Create the environment from the environment.yml file:

conda env create -f environment.yml

The first line of the yml file sets the new environment's name. For details see Creating an environment file manually.

Activate the new environment: conda activate notaetools

Verify that the new environment was installed correctly:

conda env list

You can also use conda info --envs.

Updating the local repository

First, pull the latest commits from remote:

git pull

Next, update your existing environment, notaetools, via the environment.yml file:

conda env update --file environment.yml --prune

Exporting the environment.yml file

If you add/remove/upgrade/downgrade any dependencies, then you need to reflect the changes to the envrionment.yml file.

conda env export > environment.yml

Running the App (PDF viewer)

Make sure that the conda environment is active. Then, use your shell and run the pdf_viewer.py script:

python pdf_viewer.py

The prompt outputs something like this:

Dash is running on http://127.0.0.1:8085/

You should then open a web page and go to 127.0.0.1:8085.

References

• Environment