v0.15.0 (#128)

- Replaces data backend with DuckDB + Ibis, making plotting 2-3x faster and object lookup up to 10x faster
- Changes default unit of right ascension to degrees (0...360)
- Improves performance of constellation label placement
- Separates the constellation Serpens into two "separate" parts (Cauda and Caput)
- Adds a new "blue gold" style extension
- 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`

Author: steveberardi

.github/workflows/docs.yml

@@ -16,15 +16,18 @@ jobs:
 
     - name: Build Docker image
       run: make build
+    
+    - name: Build sky.db
+      run: make db CI=true
 
     - name: Build Examples
       run: make examples
 
     - name: Build Tutorial
       run: make tutorial
 
-    - name: Build OpenNGC Data Reference
-      run: make scripts SCRIPT=ongc_docdata
+    - name: Build Data Reference
+      run: make build-doc-data
 
     - name: Build Docs
       run: make docs-build

.github/workflows/release.yml

@@ -10,18 +10,28 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v4
+
     - name: Build Docker Image
       run: make build
+    
     - name: Check Lint
       run: make lint CI=true
+    
     - name: Check Format
       run: make format CI=true ARGS=--check
+    
+    - name: Build sky.db
+      run: make db CI=true
+
     - name: Run Tests
       run: make test CI=true
+    
     - name: Check Image Hashes
       run: make check-hashes CI=true
+    
     - name: Build
       run: make flit-build
+    
     - name: Publish
       env:
         FLIT_USERNAME: __token__

.github/workflows/test.yml

@@ -15,6 +15,8 @@ jobs:
     - uses: actions/checkout@v4
     - name: Build Docker Image
       run: make build
+    - name: Build sky.db
+      run: make db CI=true
     - name: Check Lint
       run: make lint CI=true
     - name: Check Format
@@ -25,30 +27,28 @@ jobs:
       run: make check-hashes CI=true
     - name: Build PIP Package
       run: make flit-build
-  test-python-3-9:
-    runs-on: ubuntu-22.04
-    steps:
-    - uses: actions/checkout@v4
-    - name: Run Tests - Python 3.9
-      run: make test-3.9 CI=true
+
   test-python-3-10:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v4
     - name: Run Tests - Python 3.10
       run: make test-3.10 CI=true
+  
   test-python-3-11:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v4
     - name: Run Tests - Python 3.11
       run: make test-3.11 CI=true
+  
   test-python-3-12:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v4
     - name: Run Tests - Python 3.12
       run: make test-3.12 CI=true
+  
   # Python 3.13 not supported yet, needs investigation!
   # test-python-3-13:
   #   runs-on: ubuntu-22.04

.gitignore

@@ -9,17 +9,28 @@ hip8.dat
 CometEls.txt
 ongc.gpkg
 
-# Big Sky - Full Catalog
+duckdb-extensions
+
+# Sky Object Database
+# ignore this because it's large and created on release
+sky.db
+
+# Data Folder
+data/build/*
+!data/build/.keep
+
+# Big Sky Catalog
 # we ignore this because of its size (50+ MB)
-bigsky.stars.csv.gz
-stars.bigsky.parquet
+bigsky.*.csv.gz
+bigsky*.parquet
 
 hash_checks/data/*.png
 hash_checks/results.html
 
+temp*
 temp.py
 temp/
-raw/
+# raw/
 scripts/temp/
 
 # Documentation Generated Files

Dockerfile

@@ -7,17 +7,21 @@ WORKDIR /starplot
 RUN apt-get clean && apt-get update -y && apt-get install -y libgeos-dev libgdal-dev
 
 # ---------------------------------------------------------------------
-FROM base as dev
+FROM base AS dev
 
 WORKDIR /starplot
 
 COPY . .
 
-RUN pip install -r requirements.txt
-RUN pip install -r requirements-dev.txt
+RUN pip install uv
+RUN uv pip install --system -r requirements.txt
+RUN uv pip install --system -r requirements-dev.txt
 
 ENV PYTHONPATH=/starplot/src/
 
 RUN git config --global --add safe.directory /starplot
 
+# Build database
+RUN python data/scripts/db.py
+
 CMD ["bash", "-c", "python -m pytest . && python hash_checks/hashio.py check"]

Makefile

@@ -4,7 +4,7 @@ DE421_URL=https://naif.jpl.nasa.gov/pub/naif/generic_kernels/spk/planets/a_old_v
 ifeq ($(CI), true)
  DR_ARGS=
 else
- DR_ARGS=-it
+ DR_ARGS=-it --env-file ./.env
 endif
 
 ifeq ($(PROFILE), true)
@@ -13,11 +13,11 @@ else
  SCRATCH_ARGS=
 endif
 
-DOCKER_RUN=docker run --rm --env-file ./.env $(DR_ARGS) -v $(shell pwd):/starplot starplot-dev bash -c
+DOCKER_RUN=docker run --rm $(DR_ARGS) -v $(shell pwd):/starplot starplot-dev bash -c
 DOCKER_BUILDER=starplot-builder
 
 DOCKER_BUILD_PYTHON=docker build -t starplot-$(PYTHON_VERSION) $(DOCKER_BUILD_ARGS) --build-arg="PYTHON_VERSION=$(PYTHON_VERSION)" --target dev .
-DOCKER_RUN_PYTHON_TEST=docker run --rm $(DR_ARGS) -v $(shell pwd):/starplot starplot-$(PYTHON_VERSION)
+DOCKER_RUN_PYTHON_TEST=docker run --rm $(DR_ARGS) starplot-$(PYTHON_VERSION)
 
 export PYTHONPATH=./src/
 
@@ -36,7 +36,7 @@ lint:
 	$(DOCKER_RUN) "ruff check src/ tests/ hash_checks/ $(ARGS)"
 
 format:
-	$(DOCKER_RUN) "python -m black src/ tests/ scripts/ examples/ hash_checks/ tutorial/ $(ARGS)"
+	$(DOCKER_RUN) "python -m black src/ tests/ scripts/ examples/ hash_checks/ tutorial/ data/ $(ARGS)"
 
 test:
 	$(DOCKER_RUN) "python -m pytest --cov=src/ --cov-report=term --cov-report=html ."
@@ -70,11 +70,28 @@ profile:
 	$(DOCKER_RUN) "python -m cProfile -o temp/results.prof scripts/scratchpad.py && \
 	snakeviz -s -p 8080 -H 0.0.0.0 temp/results.prof"
 
-prep-dsos:
-	$(DOCKER_RUN) "python -m starplot.data.prep.dsos"
+# builds ALL data files and then database:
+db: 
+	@$(DOCKER_RUN) "python data/scripts/db.py"
 
-prep-constellations:
-	$(DOCKER_RUN) "python -m starplot.data.prep.constellations"
+build-data-clean:
+	mkdir -p data/build
+	rm -rf data/build/*
+
+build-stars-mag11:
+	@$(DOCKER_RUN) "python data/scripts/bigsky_mag11.py"
+
+build-dsos:
+	@$(DOCKER_RUN) "python data/scripts/dsos.py"
+
+build-star-designations:
+	@$(DOCKER_RUN) "python data/scripts/star_designations.py"
+
+build-constellations:
+	@$(DOCKER_RUN) "python data/scripts/constellations.py"
+
+build-doc-data:
+	@$(DOCKER_RUN) "python data/scripts/docdata.py"
 
 version:
 	@$(DOCKER_RUN) "python -c 'import starplot as sp; print(sp.__version__)'"
@@ -129,6 +146,9 @@ flit-publish: DR_ARGS=-e FLIT_USERNAME -e FLIT_PASSWORD
 flit-publish:
 	$(DOCKER_RUN) "python -m flit publish"
 
+flit-install:
+	FLIT_ROOT_INSTALL=1 flit install
+
 # ------------------------------------------------------------------
 # Utils
 ephemeris:
@@ -151,4 +171,4 @@ clean:
 	rm -rf htmlcov
 	rm -f tests/data/*.png
 
-.PHONY: build test shell flit-build flit-publish clean ephemeris hip8 scratchpad examples scripts tutorial
+.PHONY: build test shell flit-build flit-publish clean ephemeris hip8 scratchpad examples scripts tutorial prep-dsos prep-constellations

README.md

@@ -1,8 +1,8 @@
 # <img src="https://raw.githubusercontent.com/steveberardi/starplot/main/docs/images/favicon.svg" width="48" style="vertical-align:middle"> Starplot
-![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/steveberardi/starplot/test.yml?style=for-the-badge&color=a2c185)
-![Python](https://img.shields.io/pypi/pyversions/starplot?style=for-the-badge&color=85A2C1)
-![PyPI](https://img.shields.io/pypi/v/starplot?style=for-the-badge&color=85C0C1)
-![License](https://img.shields.io/github/license/steveberardi/starplot?style=for-the-badge&color=A485C1)
+![Python](https://img.shields.io/pypi/pyversions/starplot?style=for-the-badge&color=6388b0)
+![PyPI](https://img.shields.io/pypi/v/starplot?style=for-the-badge&color=57a8a8)
+![License](https://img.shields.io/github/license/steveberardi/starplot?style=for-the-badge&color=8b63b0)
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/steveberardi/starplot/test.yml?style=for-the-badge&color=88b063)
 
 **Starplot** is a Python library for creating star charts and maps of the sky.
 
@@ -13,6 +13,7 @@
 - 🪐 **Planets and Deep Sky Objects (DSOs)** - more than 14,000 objects built-in
 - 🎨 **Custom Styles** - for all objects
 - 📥 **Export** - png, svg, jpeg
+- 🚀 **Data Backend** - powered by DuckDB + Ibis for fast object lookup
 - 🧭 **Label Collision Avoidance**
 
 ## Examples
@@ -48,7 +49,7 @@ p = sp.MapPlot(
     autoscale=True,
 )
 p.constellations()
-p.stars(mag=4.6)
+p.stars(where=[_.magnitude < 4.6])
 p.constellation_labels()
 p.export("starchart.png")
 ```
@@ -74,7 +75,6 @@ https://discord.gg/WewJJjshFu
 Contributing to Starplot is welcome and very much appreciated! Please see [here](CONTRIBUTING.md) for details.
 
 ## Coming Soon
-- 🗄️ Data optimizations
 - 🧮 Coordinate system helpers
 - 🌑 Planet moons
 - ✴️ Custom markers