Setup#

Installation#

Note

As of version 0.1.4b, the VAMToolbox is only compatible with Windows operating system.

A prerequiste to install VAMToolbox is to install the Anaconda or Miniconda package manager.

Conda#

The VAMToolbox is available at the VAMToolbox channel in the conda package manager. Run the following inside a conda environment:

conda install vamtoolbox -c vamtoolbox -c conda-forge -c astra-toolbox

Warning

This command is different than what Anaconda.org suggests. This is because to properly install the dependencies you must tell conda to search in the astra-toolbox and vamtoolbox channels (in addition to the conda-forge channel, this is a default channel but is added to be explicit).

Astra Toolbox#

If there are problems with the installation of Astra Toolbox go to the downloads page and install the latest Python version by following the installation instructions.

Updating or downgrading#

For updating, type into the Anaconda prompt:

conda update vamtoolbox -c vamtoolbox -c conda-forge -c astra-toolbox

For downgrading, type into the Anaconda prompt replacing x.x.x with the version to downgrade to:

conda install vamtoolbox==x.x.x -c vamtoolbox -c conda-forge -c astra-toolbox

Note

The same channel specifications apply here, like in installation.

Uninstallation#

Use the Anaconda prompt for one of the following steps.

To remove the toolbox from the base environment (where myenv is replaced by the name of the environment in which VAMToolbox is installed):

conda remove -n myenv vamtoolbox --all

To remove the toolbox from the current environment:

conda remove vamtoolbox --all