GETTING STARTED

Instructions how to install the Python package mdsanima-dev on your system.

INSTALLATION OPTIONS

Options PyPI allows you to install the package globally on your system. If you want to install the package in an isolated environment on your system use the virtualenv options.

USING PYPI

Install latest version:

python3 -m pip install mdsanima-dev

Install specific version:

python3 -m pip install mdsanima-dev==0.2.0

Upgrade package to latest version:

python3 -m pip install --upgrade mdsanima-dev

Reinstall package to latest version:

python3 -m pip install --force-reinstall msdsanima-dev

Uninstall package:

python3 -m pip uninstall mdsanima-dev

USING VIRTUALENV

Clone repository with all number of commits history using HTTPS:

git clone https://github.com/mdsanima-dev/mdsanima-dev.git

Clone repository with the specified number of commits history using SSH:

git clone --depth=1 git@github.com:mdsanima-dev/mdsanima-dev.git

Then go to the repository directory:

cd mdsanima-dev

Make sure you have virtualenv installed on your system. If not, enter this command:

sudo apt update && sudo apt install virtualenv
python3 -m pip install --upgrade virtualenv

Creating and activating the development environment, and then installing the necessary packages, enter the following commands in the terminal:

virtualenv --pip=23.3.1 --python=python3.12 .venv
source .venv/bin/activate
pip install ".[dev]"

All dependencies for this project are specified in the project’s TOML configuration.

You can install these dependencies using the pip install . command, which will build our package and install the basic dependencies along with the new version of our package. To install dev dependencies, you can use the pip install ".[dev]" command instead of specifying a -r flag and file as mentioned earlier.

After following the above instructions, we can start writing the program. You can also refer to the instructions regarding the configuration of the development environment, which are included in this workflow guide.

Install build tools for creating distribution, then build package from source, type in terminal:

pip install --upgrade build
python -m build

Finnaly install the package in virtual environment, type in the terminal:

pip install --force-reinstall dist/mdsanima_dev-0.2.0-py3-none-any.whl

In this case I used the --force-reinstall option because I had an earlier version of this package already installed.

Also you can build Sphinx documentation, type in terminal:

python setup.py build_sphinx
cd build/dirhtml
python -m http.server 8080

Now open localhost to see the documentation.

Deactivate virtual environment, type in the terminal:

deactivate