Installation

Sergey Aganezov jr edited this page Aug 9, 2016 · 9 revisions

CAMSA is distributed as standalone Python package with the help of PyPI platform. Installation process is thus very simple and is supported on all major platform, where Python language interpreter is available.

CAMSA installation provides a set of executable scripts, to work with CAMSA itself its utilities, that might come in handy in pre/post data preparation/processing.

Note: only Linux and Mac OS were tested with respect to the installation process. If you are considering using CAMSA on windows -- please let us know, so we can use your help in testing it out and making available for everyone else.

CAMSA supports both Python2 (2.7+) and Python3 (3.3+) out of the box.

Simplest way to install CAMSA is using the command line interphase and pip, which comes standard with all Python interpreters.

Virtual environment

When using virtual environment installation approach, one isolates a particular CAMSA version, so all of its site-packages do not conflict with the ones in the Python interpreter installation.

To install open your terminal and type the following commands:

    pip install virtualenv
    virtualenv camsa-env
    source camsa-env/bin/activate
    pip install camsa

This will install CAMSA and all the packages that it depends on. All scripts are added to the environment bin directory. If followed the installation code above, all scripts will be located in camsa-env/bin.

Try running CAMSA, as follows, to see, that all the dependencies have been resolved and installed correctly:

    camsa-env/bin/run_camsa.py --help

Platform wide installation

One can chose to make a platform / user wide installation, rather than going for virtual environment. This approach has a benefit of automatically adding CAMSA scripts to the bin directory, which is already in your PATH.

To install open your terminal and type the following commands:

    sudo pip install camsa

Once this process is completed successfully, make sure that installation went fully and correctly, by running:

    run_camsa.py --help

This will install CAMSA and all the packages that it depends on. All scripts are added to the platform/user bin directory (usually /usr/local/bin/ or /usr/bin).

Upgrading CAMSA to a new version

To upgrade CAMSA to a new version simply run:

    pip install -U camsa

Uninstall

To uninstall CAMSA simply run

    pip uninstall camsa

Remarks

When working with pip, make sure, that the Python interpreter, from which this pip is coming from is the same Python interpreter, that was used during the installation process.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.