v0.9.0 (#57)

- Added perspective projections (Orthographic, Stereographic) to map plots - many thanks to @bathoorn
- Zenith plots are now a type of projection for map plots, to support plotting the milky way, constellation borders and more - many thanks to @bathoorn
- Removed the visible style property and instead now you control what is plotted by calling functions on the plot (e.g. p.stars(mag=8)) to be more consistent with other plotting frameworks and allow more control over what's plotted and how. For example, now you can do things like plotting very bright stars with a different marker (and sizes, etc) than dimmer stars.
- Optional callables for calculating star size/alpha/color when plotting stars
- Nebula outlines! via OpenNGC
- Stars are now plotted in order of their calculated size, which prevents "bigger" stars from hiding "smaller" stars
- Added more marker symbols and style extensions

Co-authored-by: Ronnie Bathoorn

Author: steveberardi

.github/workflows/docs.yml

@@ -12,11 +12,20 @@ jobs:
       id-token: 'write'
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Build Docker image
       run: make build
 
+    - name: Build Examples
+      run: make examples
+    
+    - name: Build Gallery
+      run: make gallery
+    
+    - name: Build OpenNGC Data Reference
+      run: make scripts SCRIPT=ongc_docdata
+
     - name: Build Docs
       run: make docs-build
 
@@ -25,12 +34,12 @@ jobs:
       with:
         credentials_json: '${{ secrets.GCP_CREDENTIALS }}'
 
-    - name: 'Set up Cloud SDK'
+    - name: 'Set up Google Cloud SDK'
       uses: 'google-github-actions/setup-gcloud@v1'
       with:
         version: '>= 363.0.0'
 
-    - name: 'Use gcloud CLI'
+    - name: 'Sync docs to Cloud Storage Bucket'
       run: 'gsutil -m rsync -R -d site gs://starplot.dev'
 
 

.github/workflows/release.yml

@@ -9,7 +9,7 @@ jobs:
   publish:
     runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Build Docker Image
       run: make build
     - name: Check Lint

.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
   test-lint-build:
     runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Build Docker Image
       run: make build
     - name: Check Lint
@@ -25,24 +25,24 @@ jobs:
   test-python-3-9:
     runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v3
+    - 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@v3
+    - 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@v3
+    - 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@v3
+    - uses: actions/checkout@v4
     - name: Run Tests - Python 3.12
       run: make test-3.12 CI=true

.gitignore

@@ -22,6 +22,9 @@ CometEls.txt
 temp*
 raw/
 examples/*.png
+docs/images/examples/*.png
+docs/images/gallery/*.png
+docs/data/*.json
 
 *.prof
 

Dockerfile

@@ -3,7 +3,7 @@ FROM python:${PYTHON_VERSION}-bookworm AS base
 
 WORKDIR /starplot
 
-RUN apt-get update -y && apt-get install -y libgeos-dev libgdal-dev
+RUN apt-get clean && apt-get update -y && apt-get install -y libgeos-dev libgdal-dev
 
 # Install fonts
 # not required, but make the maps look better (especially greek letters)

Makefile

@@ -32,7 +32,7 @@ docker-multi-arch:
 	docker buildx build --push --platform linux/arm64/v8,linux/amd64 --tag sberardi/starplot-base:latest --target base .
 
 lint:
-	$(DOCKER_RUN) "ruff check src/ tests/"
+	$(DOCKER_RUN) "ruff check src/ tests/ $(ARGS)"
 
 format:
 	$(DOCKER_RUN) "python -m black src/ tests/ scripts/ examples/ $(ARGS)"
@@ -44,14 +44,17 @@ bash:
 	$(DOCKER_RUN) bash
 
 shell:
-	$(DOCKER_RUN) python
+	$(DOCKER_RUN) ipython
 
 scratchpad:
 	$(DOCKER_RUN) "python $(SCRATCH_ARGS) scripts/scratchpad.py"
 
 examples:
 	$(DOCKER_RUN) "cd examples && python examples.py"
 
+gallery:
+	$(DOCKER_RUN) "python scripts/gallery.py"
+
 # ------------------------------------------------------------------
 # Python version testing
 # ------------------------------------------------------------------
@@ -79,7 +82,7 @@ test-3.12:
 # Docs
 docs-serve: DR_ARGS=-it -p 8000:8000
 docs-serve:
-	$(DOCKER_RUN) "mkdocs serve -a 0.0.0.0:8000 --watch src/"
+	$(DOCKER_RUN) "mkdocs serve -a 0.0.0.0:8000 -q --watch src/"
 
 docs-build:
 	$(DOCKER_RUN) "mkdocs build"
@@ -113,5 +116,6 @@ clean:
 	rm -rf dist
 	rm -rf site
 	rm -rf htmlcov
+	rm -f tests/data/*.png
 
-.PHONY: install test shell flit-build flit-publish clean ephemeris hip8 scratchpad examples scripts
+.PHONY: build test shell flit-build flit-publish clean ephemeris hip8 scratchpad examples scripts

README.md

@@ -35,13 +35,19 @@ import starplot as sp
 
 tz = timezone("America/Los_Angeles")
 
-p = sp.ZenithPlot(
-    lat=33.363484, 
+p = sp.MapPlot(
+    projection=Projection.ZENITH,
+    lat=33.363484,
     lon=-116.836394,
     dt=datetime.now(tz).replace(hour=22),
-    limiting_magnitude=4.6,
+    style=sp.styles.PlotStyle().extend(
+        sp.styles.extensions.BLUE_MEDIUM,
+        sp.styles.extensions.ZENITH,
+    ),
     resolution=2000,
 )
+p.constellations()
+p.stars(mag=4.6, mag_labels=2.1)
 p.export("starchart.png")
 ```
 
@@ -67,10 +73,9 @@ For a demo of Starplot's zenith plots, check out:
 - adjustText
 
 ## Coming Soon
-- ⚙️ Callables for star sizes/colors/alpha
 - ✴️ Custom markers
-- 📐 Nebula outlines
-- 🌐 More map projection options
+- 📋 List of objects plotted
+- 📐 More Nebula outline levels
 - ⚖️ Better auto font-size adjustment
 - ☄️ Better label collision detection and handling
 

docs/about.md

@@ -6,7 +6,7 @@
 
 ### _Note from the author..._
 
-Like many amateur astronomers, when I first started looking up at the sky through a scope I bought the wonderful book [_Turn Left at Orion_](https://www.amazon.com/Turn-Left-Orion-Hundreds-Telescope-dp-1108457568/dp/1108457568/), and it was such a useful book for learning how to find stuff in the sky. The thing that helped me the most were all the finder charts that show an object in various ways: first a general overview of where the object is in the sky (useful for finding the object with your naked eye), and then vector drawings of what the object looks like through a medium/high power scope (including any transformations to the image from mirrors in the scope). These really helped me confirm I found the object.
+Like many amateur astronomers, when I first started looking up at the sky through a scope I bought the wonderful book [_Turn Left at Orion_](https://www.amazon.com/Turn-Left-Orion-Hundreds-Telescope-dp-1108457568/dp/1108457568/), and it really helped me learn how to find stuff in the sky. The thing that helped me the most were all the finder charts that show an object in various ways: first a general overview of where the object is in the sky (useful for finding the object with your naked eye), and then vector drawings of what the object looks like through a medium/high power scope (including any transformations to the image from mirrors in the scope). These really helped me confirm I found the object.
 
 After finding most of the sky objects in _Turn Left at Orion_, I tried finding another book or software that would create those finder charts in the book for any spot in the sky, but I couldn't find anything. That was my main motivation for creating Starplot.