Installation

diskmap is compatible with Python versions 3.9/3.10/3.11 and available through PyPI and Github.

Installation from PyPI

diskmap can be installed from PyPI with the pip package manager:

$ pip install diskmap

Or to update the package to the most recent version:

$ pip install --upgrade diskmap

Installation from Github

Using pip

Installation from Github is also possible with pip:

$ pip install git+https://github.com/tomasstolker/diskmap.git

Cloning the repository

Alternatively, the Github repository can be cloned, which is in particular useful if you want to look into and/or make changes to the code

$ git clone https://github.com/tomasstolker/diskmap.git

The package is installed by running pip in the local cloned repository:

$ pip install -e .

Once a local copy of the repository exists, new commits can be pulled from Github with:

$ git pull origin main

Do you want to makes changes to the code? Then please fork the diskmap repository on the Github page and clone your own fork instead of the main repository. Contributions and pull requests are welcome (see About section).

Testing diskmap

The installation can be tested by starting Python in interactive mode, importing diskmap, and printing the installed version number:

>>> import diskmap
>>> diskmap.__version__