Skip to content

Installation#

Dependencies#

Required dependencies#

Note

Writing animations to mp4 / mov / avi also needs an FFmpeg binary on your PATH. GIF export uses matplotlib's PillowWriter and needs no FFmpeg.

Optional dependencies — the tiles extra#

The web-tile basemap helper (cleopatra.tiles.add_tiles) needs four extra packages. They are bundled in the cleopatra[tiles] extra (pip) / the cleopatra-tiles package (conda) and are otherwise not installed:

It is recommended to install cleopatra into a virtual environment so its requirements do not interfere with your system Python.

conda#

cleopatra is available in the conda-forge channel:

conda install -c conda-forge cleopatra

# with the optional web-tile basemap support
conda install -c conda-forge cleopatra-tiles

The conda packages are built from the cleopatra-feedstock; the cleopatra-tiles output simply pulls in cleopatra plus the four [tiles] dependencies.

pip#

pip install cleopatra

# with the optional web-tile basemap support (cleopatra.tiles.add_tiles)
pip install "cleopatra[tiles]"

From sources#

The sources for cleopatra are hosted on the GitHub repo.

Install the latest development version directly from GitHub:

pip install git+https://github.com/serapeum-org/cleopatra.git

Or clone and do an editable install for development:

git clone https://github.com/serapeum-org/cleopatra.git
cd cleopatra
pip install -e .

Check the installation#

To confirm the install succeeded, import the package and print its version:

python -c "import cleopatra; print(cleopatra.__version__)"

This should print the installed version without errors.

Documentation#