Welcome to offline-inspect’s documentation!

Installation

Install the Python 3 package directly from github. To be able to do this, you have to install git first. Additionally, you need a Python 3 installation- We recommend Anaconda, especially if you are a beginner with Python. If you have an issue with installing it, chat us up on our slack channel.

After these two general requisites have been installed, you can download and install the package from your terminal (e.g. git bash, linux bash or windows command prompt or anaconda prompt) as follows

git clone https://github.com/translationalneurosurgery/tool-offspect.git
cd tool-offspect
pip install -r requirements.txt
pip install -e .

If you have a fresh Anaconda Installation, this should work out of the box. Otherwise, try pip install wheel first, as we might install some wheels with some precompiled libraries. Another solution to issues is setting up a fresh environment. You can do so with

pip install virtualenv
virtualenv .env
source .env/bin/activate # on linux or mac
.env\Scripts\activate # on windows
pip install -r requirements.txt
pip install -e .
# at a later stage, you can deactivate the environment with
deactivate

Updating

You can update the offline-inspection tool from the project root with

git pull
pip install -r requirements.txt
pip install -e .

Indices and tables