Installation

You can either install miop by cloning the repository and running pip install . in your Python environment, or by directly using pip install git+https://gitlab.com/miop-project/miop.git

We provide below the detailed instructions for both cases.

Note

The code has been tested with Python 3.11.

Installing by cloning the Repository

First, clone the repository and move to the newly created directory:

git clone https://gitlab.com/miop-project/miop.git

cd miop

Create a new virtual environment with Python >= 3.11 and activate it:

# Set the name of the virtual environment
venv_name="name_of_venv"

# Create virtual environment
/usr/bin/python3.11 -m venv $venv_name

# Activate virtual environment
source $venv_name/bin/activate

Install miop in the virtual environment:

pip install .

If you plan on using miop in a Jupyter notebook, create a new Python kernel:

pip install ipykernel

# Create kernel for Jupyter
sudo ./$venv_name/bin/python3.11 -m ipykernel install --name "$venv_name"

Installing without cloning the Repository

# Set the name of the directory and virtual environment
dir_name="name_of_dir"
venv_name="name_of_venv"

mkdir $dir_name
cd $dir_name

# Create virtual environment
/usr/bin/python3.11 -m venv $venv_name

# Activate virtual environment
source $venv_name/bin/activate

# Install miop
pip install git+https://gitlab.com/miop-project/miop.git

If you plan on using miop in a Jupyter notebook, create a new Python kernel:

pip install ipykernel

# Create kernel for Jupyter
sudo ./$venv_name/bin/python3.11 -m ipykernel install --name "$venv_name"