Skip to content

Installation

Starplot is available on PyPI, and its dependencies have binary wheels for most operating systems, so installation should be easy via pip. See below for details.

Supported Python versions: 3.10 / 3.11 / 3.12

1. Install Starplot

pip install starplot

2. Setup Starplot (optional)

starplot setup --install-big-sky
This will install the required spatial extension for DuckDB, build the matplotlib font cache, and download the full Big Sky catalog. Starplot will do this automatically, but this setup command is a way to do it ahead of time (useful for deployed environments, continuous integration, etc). You can control where Starplot stores these files via environment variables.

Troubleshooting

GEOS / GDAL errors on installation

If you see any errors related to GEOS and/or GDAL when trying to install Starplot, then you may need to build those dependencies from source for your environment.

See their websites for details:

Segmentation Fault with map plots

If you're seeing "segmentation fault" errors when creating map plots, you may have to install shapely from source for your runtime environment: 

pip install --no-binary :all: shapely
Warning: this may take awhile (5+ minutes), because it builds shapely from source.

Other Issues

If you experience another problem, then please open an issue on our GitHub page and include the following information: operating system (and version), Python version, Starplot version, and Matplotlib version.