Installation#

This section describes how to install arim for an end-user. For developer installation, see the developer install guide or Contributing.md in arim’s git repository.

Requirements#

arim has the following requirements:

The following dependencies are needed for the example scripts, although they may not be directly used in arim:

  • pandas: data analysis tools

  • pooch: for downloading data files

Finally, some users may require the following package:

Installation (stable)#

Make sure you have a working Anaconda installation with Python v3.9 or greater.

Anaconda will already have many requirements already installed, however you may have to install …

From the arim releases page, download the most recent wheel package (*.whl file).

Open the Anaconda Prompt, navigate to the directory where the wheel file was downloaded, and install this file

cd <download-directory>
pip install <arim-wheel-file>

For the most recent version, this is

cd <download-directory>
pip install arim-0.9-py3-none-any.whl

Make sure you have a working conda or mamba installation. Note that for the remainder of this section the conda command will be used - this may be replaced with mamba if this is your package manager.

Open the Anaconda Prompt or Miniforge Prompt, and create a new environment with the required packages installed

conda create -n <env-name> numpy scipy numba matplotlib pyyaml pandas pooch h5py

Activate this new environment

conda activate <env-name>

From the arim releases page, download the most recent wheel package (*.whl file).

In the prompt, navigate to the directory where the wheel file was downloaded, and install this file

cd <download-directory>
pip install <arim-wheel-file>

For the most recent version, this is

cd <download-directory>
pip install <arim-wheel-file>

arim will now be installed in your environment. Verify your installation

>>> import arim
>>> print(arim.__version__)

Installation (latest)#

Make sure you have a working installation of Anaconda, Conda or Mamba. Make sure that your desired environment is active, and that the requirements are installed. See Conda / mamba environment for instructions.

From the main arim repository, click the green Code button, and Download ZIP to download the latest version.

After it has downloaded, extract the contents of the zip file.

Open your Anaconda Prompt or Miniforge Prompt, navigate to the extracted folder, and install the contents of the directory

cd <extract-directory>
pip install .

Open your Anaconda Prompt or Miniforge Prompt, and run

pip install git+https://github.com/ndtatbristol/arim

arim will now be installed in your environment. Verify your installation

>>> import arim
>>> print(arim.__version__)