Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
steveberardi committed Feb 7, 2025
1 parent a937ad7 commit ebc6775
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 25 deletions.
3 changes: 0 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ FROM python:${PYTHON_VERSION}-bookworm AS base

WORKDIR /starplot

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

# ---------------------------------------------------------------------
FROM base AS dev

Expand Down
2 changes: 2 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
- Adds a new field to the constellation model: `star_hip_ids` which is a list of hip ids for stars that make up the lines in the constellation
- Dropped support for Python 3.9 (Ibis requires 3.10 or higher)
- Increased minimum required version of GeoPandas to `1.0.1`
- [**v0.15.1**] Fixes bug with build script that prevented starplot data from being included in the distribution
- [**v0.15.2**] Fixes a few colors in the dark blue and blue gold style extensions

## v0.14.x
[Documentation](https://archives.starplot.dev/0.14.0/)
Expand Down
37 changes: 16 additions & 21 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,15 @@
Starplot is available on [PyPI](https://pypi.org/project/starplot/), but it's basically just a thin layer on top of [Matplotlib](https://matplotlib.org/stable/), [Skyfield](https://github.com/skyfielders/python-skyfield), [Cartopy](https://scitools.org.uk/cartopy/docs/latest/), and others. So, before installing Starplot you'll need a few dependencies. Below are instructions for installing on macOS and Linux.
Starplot is available on [PyPI](https://pypi.org/project/starplot/), 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

Required Dependencies: [GEOS](https://libgeos.org/), [GDAL](https://gdal.org/)
## macOS / Linux

## macOS / Linux (debian)

1. **Install required system libraries**

macOS (via [Homebrew](https://brew.sh/)):
```
brew install geos gdal
```
Linux (debian):
```
apt-get install libgeos-dev libgdal-dev
```
2. **Install Starplot:**
1. **Install Starplot:**
```
pip install starplot
```

3. (optional) **Setup Starplot:**
2. (optional) **Setup Starplot:**
```
starplot setup --install-big-sky
```
Expand All @@ -36,9 +22,6 @@ Here's a basic Docker container definition that'll get you up and running:
```docker
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
RUN starplot setup --install-big-sky # Optional
```
Expand All @@ -51,10 +34,22 @@ RUN starplot setup --install-big-sky # Optional

## 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:

- [GEOS](https://libgeos.org/)
- [GDAL](https://gdal.org/)

### Segmentation Fault with map plots

If you're seeing "segmentation fault" errors when creating map plots, you may have to install [shapely](https://shapely.readthedocs.io/en/stable/index.html) 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.*


<br/><br/><br/>
2 changes: 1 addition & 1 deletion src/starplot/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Star charts and maps of the sky"""

__version__ = "0.15.1"
__version__ = "0.15.2"

from .base import BasePlot # noqa: F401
from .map import MapPlot, Projection # noqa: F401
Expand Down

0 comments on commit ebc6775

Please sign in to comment.