Skip to content

Installation#

Dependencies#

Required dependencies#

Stable release#

Please install cleopatra in a Virtual environment so that its requirements don't tamper with your system's python.

conda#

The easiest way to install cleopatra is using conda package manager. cleopatra is available in the conda-forge channel. To install you can use the following command:

conda install -c conda-forge cleopatra

If this works it will install cleopatra with all dependencies including Python, and you skip the rest of the installation instructions.

Installing Python and gdal dependencies#

The main dependencies for cleopatra are an installation of Python 3.11+

Installing Python#

For Python, we recommend using the Anaconda Distribution for Python 3, which is available for download from https://www.anaconda.com/download/. The installer gives the option to add python to your PATH environment variable. We will assume in the instructions below that it is available in the path, such that python, pip, and conda are all available from the command line.

Note that there is no hard requirement specifically for Anaconda's Python, but often it makes installation of required dependencies easier using the conda package manager.

Install as a conda environment#

The easiest and most robust way to install Hapi is by installing it in a separate conda environment. In the root repository directory there is an environment.yml file. This file lists all dependencies. Either use the environment.yml file from the master branch (please note that the master branch can change rapidly and break functionality without warning), or from one of the releases {release}.

Run this command to start installing all Hapi dependencies:

conda env create -f environment.yml

This creates a new environment with the name cleopatra. To activate this environment in a session, run:

conda activate cleopatra

For the installation of Hapi there are two options (from the Python Package Index (PyPI) or from Github). To install a release of Hapi from the PyPI (available from release 2018.1):

pip install cleopatra=={release}

From sources#

The sources for HapiSM can be downloaded from the Github repo.

You can either clone the public repository:

git clone git://github.com/Serapieum-of-alex/cleopatra

Or download the tarball:

curl -OJL https://github.com/Serapieum-of-alex/cleopatra/tarball/main

Once you have a copy of the source, you can install it with:

python pip install .

To install directly from GitHub (from the HEAD of the master branch):

pip install git+https://github.com/Serapieum-of-alex/cleopatra.git

or from Github from a specific release:

pip install git+https://github.com/Serapieum-of-alex/cleopatra.git@{release}

Now you should be able to start this environment's Python with python, try import cleopatra to see if the package is installed.

More details on how to work with conda environments can be found here: https://conda.io/docs/user-guide/tasks/manage-environments.html

If you are planning to make changes and contribute to the development of Hapi, it is best to make a git clone of the repository, and do a editable install in the location of you clone. This will not move a copy to your Python installation directory, but instead create a link in your Python installation pointing to the folder you installed it from, such that any changes you make there are directly reflected in your install.

git clone https://github.com/Serapieum-of-alex/cleopatra.git
cd cleopatra
activate cleopatra
pip install -e .

Alternatively, if you want to avoid using git and simply want to test the latest version from the main branch, you can replace the first line with downloading a zip archive from GitHub: https://github.com/Serapieum-of-alex/cleopatra/archive/master.zip libraries.io.

Install using pip#

Besides the recommended conda environment setup described above, you can also install cleopatra with pip. For the more difficult to install Python dependencies, it is best to use the conda package manager:

conda install numpy gdal

you can check libraries.io to check versions of the libraries

Then install a release {release} of cleopatra (available from release 2018.1) with pip:

pip install cleopatra=={release}

Check if the installation is successful#

To check it the install is successful, go to the examples directory and run the following command:

python -m cleopatra.*******

This should run without errors.

Note

This documentation was generated on {{ date }}

Documentation for the development version: https://cleopatra.readthedocs.org/en/latest/

Documentation for the stable version: https://cleopatra.readthedocs.org/en/stable/