Installation

Starplot is available on PyPI, but it's basically just a thin layer on top of Matplotlib, Skyfield, Cartopy, and others. So, before installing Starplot you'll need a few dependencies. Below are instructions for installing on macOS and Linux.

Supported Python versions: 3.9+

Required Dependencies: GEOS, GDAL

macOS

Install required system libraries (via Homebrew):
```
brew install geos gdal
```
Install Starplot:
```
pip install starplot
```

Linux (debian)

Install required system libraries:

apt-get install libgeos-dev libgdal-dev

Install Starplot:
```
pip install starplot
```

Docker

Here's a basic Docker container definition that'll get you up and running:

FROM python:3.11.11-bookworm

# Install required system libraries (GEOS + GDAL)
RUN apt-get clean && apt-get update -y && apt-get install -y libgeos-dev libgdal-dev

RUN pip install starplot

What about Windows?

I haven't tried installing Starplot on Windows, but if you have and would like to share instructions, please feel free to open a pull request on GitHub with an update to this file (docs/installation.md). Thanks! :)

Troubleshooting

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.