Skip to content

Installation

ADToolbox is a python package that can be executed locally by installation, or by using the containerized version with Docker. Any function that relies on external tools can be executed either adding the external tool to the operating system's environment or using the Docker or Singularity containers. Also with utility functions provided, each function can be executed through slurm job scheduler to provide interface for running in cloud/high-performance computer clusers.

Although it is not mandatory, It is greatly advised to create a python environment for this project and install ADToolbox in that environment. Check for how to build and use python's virtual environments.

There are severall methods that allow you to install or use ADToolbox:

  1. Install by cloning this repository:
git clone https://github.com/chan-csu/ADToolbox.git
cd ADToolbox
pip install .

Or if you wish to install in editable mode (contribute to the developemnt), run the following:

git clone https://github.com/chan-csu/ADToolbox.git
cd ADToolbox
pip install -e .
  1. Install using pip
pip install adtoolbox
  1. Use docker
Not available yet
  1. Click bellow:
My binder place holder