Installation¶

This guide helps you to install Nestor onto your computer. There are two modes for installation. They are as follows.

Install from PyPI (Recommended)¶

This will do a cloud install to your python installation directory.

Type in pip install nist-nestor and wait for the install to complete. This installs the Graphical User Interface (GUI) for the Nestor Tagging Tool.
(Optional Step) Type in pip install nist-nestor[dash] to also install the Nestor Dashboard (Under Development!).

This is necessary only if you did not install using the above method (using PyPI).

This will be a local install downloaded from a recent source code release on GitHub

Download the .zip file of the entire nestor installation from the Github repository
Extract the files to a directory, preferably with write access.
Open a terminal window

Navigate to the folder where the files have been extracted to (the folder will have the file setup.py in it).
Install nestor using the command pip install . (please note the “.” is part of the command)
(Optional Step) Type in pip install .[dash] to install the Nestor Dashboard (Under Development!).

This section is useful for developers of Nestor.

A version of the documentation for Nestor is hosted at Readthedocs. However you may build a local version if required.

If Nestor is not installed and you want to build a local version of the documentation, you can run pip install .[docs]. If Nestor is already installed, navigate to the installation directory and install the Sphinx dependancies by typing in pip install -r requirements/doc.txt
To build HTML documentation navigate into the docs subdirectory of Nestor and run make html. The HTML source code will be created in nestor/_build/html and can be opened with the index.html file in a browser.
To build PDF documentation LaTeX must be installed. As above, run make latex and navigate into the nestor/_build/latex directory. Run pdflatex nestor.tex.