1. Install Qumin

Qumin is a Python package, which means that a Python installation is required. Qumin requires Python 3 and is packaged for versions 3.9 to 3.13. Qumin is available through the Python package repository, and can be installed as follows:

pip install qumin

However, it is recommended that you install Qumin into a closed environment which will avoid unwanted collisions between other packages that you may have installed. This requires a few more steps.

Using Virtualenv

Virtualenv is a native Python tool to manage virtual environments in a folder. It is extremely convenient for reproducible research, as it allows to easily recreate a development environment.

Choose a location in your system and create a virtual environment:

python -m venv venv # Create the virtual environment

Each time you want to access this environment, go to the same location and run:

. venv/bin/activate # Activate the virtual environment

After activating the environment you will be able to install qumin and use it:

pip install qumin   # Install within the virtual env.
qumin -h            # Run within the virtual environment

To deactivate the environment, run

deactivate # Deactivate the virtual environment

Using Conda or Mamba

Mamba and conda are very similar to Virtualenv. As opposed to virtualenv, their installation on the system is global. When you create a new environment, they are able to reuse packages already downloaded for other environments, thus reducing the required memory. On the contrary, they are more difficult to use for reproducing specific computations on servers for instance.

You should first follow the installation instructions for mamba or for conda . In the following, replace conda by mamba depending on your installation. You are now ready to create your environment:

conda create -n Qumin python=3.12
conda activate Qumin

Just as virtualenv, do not forget to activate your environment each time you want to use Qumin. We still need to install pip and qumin:

conda install pip  # pip is not shipped with conda
pip install qumin  # just as before!
qumin -h           # run Qumin

End a session with:

conda deactivate