v0.6.0 (#40)

* grayscale dark

* scope

* initial scope plots

* handle wrapping

* star sizing

* style

* optic plot

* more optic types

* docs

* cleanup

* fix clipping

* optic labels

* optic labels

* planets and moon

* python version testing

* remove 3.8

* python 312

* refactor docker

* python version testing

* no dots

* python version testing

* fix

* format

* clean up

* docs

* examples

* optic projections

* clean up

* replace old

* cleanup

* version

* cleanup

* readme

* readme

* examples

* time

* in bounds

* tests

* tests

* format

* alternate color hash

* fix fov circle

* hash

* lint

* finder chart script

* star labels

* styling

* legends on optic plot

* reticle

* docs

* docs

* info text style

* doc

* docs

* python version

* fix polar query and optimize

* format

* optimizations

* polaris test

* format

* refactor

* fix star bounds

* label bounds

* reorg

* optics

* use parquet

* test exceptions

* docs

Author: steveberardi

.github/workflows/release.yml

@@ -10,18 +10,18 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v3
-    - name: Build Docker image - dev
-      run: make docker-dev
+    - 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: Run Tests
       run: make test CI=true
     - name: Build
-      run: make build
+      run: make flit-build
     - name: Publish
       env:
         FLIT_USERNAME: __token__
         FLIT_PASSWORD: ${{ secrets.PYPI_TOKEN }}
-      run: make publish
+      run: make flit-publish

.github/workflows/test.yml

@@ -8,17 +8,41 @@ on:
       - main
 
 jobs:
-  test:
+  test-lint-build:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v3
-    - name: Build Docker image - dev
-      run: make docker-dev
+    - 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: Run Tests
       run: make test CI=true
-    - name: Build
-      run: make build
+    - name: Build PIP Package
+      run: make flit-build
+  test-python-3-9:
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: actions/checkout@v3
+    - 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
+    - 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
+    - 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
+    - name: Run Tests - Python 3.12
+      run: make test-3.12 CI=true

.gitignore

@@ -20,6 +20,8 @@ hip8.dat
 
 temp*
 
+*.prof
+
 # test-generated data
 tests/data/actual*.png
 

Dockerfile

@@ -1,4 +1,5 @@
-FROM python:3.11.4-bookworm as base
+ARG PYTHON_VERSION=3.11.7
+FROM python:${PYTHON_VERSION}-bookworm AS base
 
 WORKDIR /starplot
 
@@ -11,18 +12,6 @@ RUN wget https://github.com/google/fonts/raw/main/ofl/gfsdidot/GFSDidot-Regular.
 RUN install -m644 /tmp/fonts/*.ttf /usr/share/fonts/truetype/
 RUN fc-cache -f
 
-# ---------------------------------------------------------------------
-FROM python:3.10.12-bookworm as base310
-
-WORKDIR /starplot
-
-RUN apt-get update -y && apt-get install -y libgeos-dev libgdal-dev
-
-# MAYBE REQUIRED for Python 3.10.x? TODO: investigate more
-# Install shapely from source to avoid cartopy segfault
-# https://stackoverflow.com/questions/52374356/
-RUN pip install --no-binary :all: shapely==2.0.1
-
 # ---------------------------------------------------------------------
 FROM base as dev
 
@@ -37,4 +26,4 @@ ENV PYTHONPATH=/starplot/src/
 
 RUN git config --global --add safe.directory /starplot
 
-CMD ["bash"]
+CMD ["bash", "-c", "python -m pytest ."]

Makefile

@@ -7,11 +7,30 @@ else
  DR_ARGS=-it
 endif
 
+ifeq ($(PROFILE), true)
+ SCRATCH_ARGS=-m cProfile -o results.prof
+else
+ SCRATCH_ARGS=
+endif
+
 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)
+
 export PYTHONPATH=./src/
 
+# ------------------------------------------------------------------
+build: PYTHON_VERSION=3.11.7
+build: DOCKER_BUILD_ARGS=-t starplot-dev
+build:
+	$(DOCKER_BUILD_PYTHON)
+
+docker-multi-arch:
+	docker buildx inspect $(DOCKER_BUILDER) && echo "Builder already exists!" || docker buildx create --name $(DOCKER_BUILDER) --bootstrap --use
+	docker buildx build --push --platform linux/arm64/v8,linux/amd64 --tag sberardi/starplot-base:latest --target base .
+
 lint:
 	$(DOCKER_RUN) "ruff check src/ tests/"
 
@@ -21,32 +40,41 @@ format:
 test:
 	$(DOCKER_RUN) "python -m pytest --cov=src/ --cov-report=term --cov-report=html ."
 
-docker-dev:
-	docker build -t starplot-dev --target dev .
-
-docker-base:
-	docker build -t starplot-base --target base .
-	docker tag starplot-base sberardi/starplot-base:latest
-
-docker-base-push:
-	docker push sberardi/starplot-base:latest
-
-docker-multi-arch:
-	docker buildx inspect $(DOCKER_BUILDER) && echo "Builder already exists!" || docker buildx create --name $(DOCKER_BUILDER) --bootstrap --use
-	docker buildx build --push --platform linux/arm64/v8,linux/amd64 --tag sberardi/starplot-base:latest --target base .
-
 bash:
 	$(DOCKER_RUN) bash
 
 shell:
 	$(DOCKER_RUN) python
 
 scratchpad:
-	$(DOCKER_RUN) "python scripts/scratchpad.py"
+	$(DOCKER_RUN) "python $(SCRATCH_ARGS) scripts/scratchpad.py"
 
 examples:
 	$(DOCKER_RUN) "cd examples && python examples.py"
 
+# ------------------------------------------------------------------
+# Python version testing
+# ------------------------------------------------------------------
+test-3.9: PYTHON_VERSION=3.9.18
+test-3.9:
+	$(DOCKER_BUILD_PYTHON)
+	$(DOCKER_RUN_PYTHON_TEST)
+
+test-3.10: PYTHON_VERSION=3.10.13
+test-3.10:
+	$(DOCKER_BUILD_PYTHON)
+	$(DOCKER_RUN_PYTHON_TEST)
+
+test-3.11: PYTHON_VERSION=3.11.7
+test-3.11:
+	$(DOCKER_BUILD_PYTHON)
+	$(DOCKER_RUN_PYTHON_TEST)
+
+test-3.12: PYTHON_VERSION=3.12.1
+test-3.12:
+	$(DOCKER_BUILD_PYTHON)
+	$(DOCKER_RUN_PYTHON_TEST)
+
 # ------------------------------------------------------------------
 # Docs
 docs-serve: DR_ARGS=-it -p 8000:8000
@@ -61,11 +89,11 @@ docs-publish:
 
 # ------------------------------------------------------------------
 # PyPi - build & publish
-build:
+flit-build:
 	$(DOCKER_RUN) "python -m flit build"
 
-publish: DR_ARGS=-e FLIT_USERNAME -e FLIT_PASSWORD
-publish:
+flit-publish: DR_ARGS=-e FLIT_USERNAME -e FLIT_PASSWORD
+flit-publish:
 	$(DOCKER_RUN) "python -m flit publish"
 
 # ------------------------------------------------------------------
@@ -74,7 +102,7 @@ ephemeris:
 	$(DOCKER_RUN) "python -m jplephem excerpt 2001/1/1 2050/1/1 $(DE421_URL) de421sub.bsp"
 
 hip8:
-	$(DOCKER_RUN) "python ./scripts/hip.py hip_main.dat hip8.dat"
+	$(DOCKER_RUN) "python ./scripts/hip.py ./src/starplot/data/library/hip_main.dat hip8.dat 15"
 
 scripts:
 	$(DOCKER_RUN) "python ./scripts/$(SCRIPT).py"
@@ -86,4 +114,4 @@ clean:
 	rm -rf site
 	rm -rf htmlcov
 
-.PHONY: install test shell build publish clean ephemeris hip8 scratchpad examples scripts
+.PHONY: install test shell flit-build flit-publish clean ephemeris hip8 scratchpad examples scripts

README.md

@@ -1,12 +1,14 @@
 # <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)
 
 **Starplot** is a Python library for creating star charts and maps.
 
 - ⭐ **Zenith Plots** - showing the stars from a specific time/location
 - 🗺️ **Map Plots** - including North/South polar and Mercator projections
+- 🔭 **Optic Plots** - simulates what you'll see through an optic (e.g. binoculars, telescope) from a time/location
 - 🪐 **Planets and Deep Sky Objects (DSOs)**
 - 🎨 **Custom Styles** - for all objects
 - 📥 **Export** - png, svg
@@ -19,6 +21,8 @@
 *Map around the constellation Orion, with M42 marked:*
 ![map-orion](https://github.com/steveberardi/starplot/blob/main/examples/03_map_orion.png?raw=true)
 
+*Optic plot of The Pleiades through a refractor as seen from a specific time/location:*
+![optic-pleiades](https://github.com/steveberardi/starplot/blob/main/examples/05_optic_m45.png?raw=true)
 
 ## Basic Usage
 
@@ -63,8 +67,6 @@ For a demo of Starplot's zenith plots, check out:
 - adjustText
 
 ## Coming Soon
-- ⭐ Custom markers
-- 🔭 Scope plots - that will simulate what you'll see through a telescope eyepiece
 - ⚖️ Better auto font-size adjustment
 - ☄️ Better label collision detection and handling
 

docs/css/extra.css

@@ -25,6 +25,7 @@
     font-weight: 600;
 }
 
+/* Object Class Headings */
 .doc-object.doc-class {
     border-top: 2px solid rgba(200, 200, 200, 0.6);
 }
@@ -39,6 +40,21 @@
     font-weight: 600;
 }
 
+/* Object Class Headings */
+.doc-object.doc-class h3.doc-heading span:nth-child(5) {
+    color:hsl(209, 53%, 37%);
+}
+.doc-object.doc-class h3.doc-heading span:nth-child(n+6) {
+    font-size: .65rem;
+    font-weight: 400;
+}
+.doc-object.doc-class h3.doc-heading span:nth-child(n+6).n {
+    font-weight: 600;
+}
+
+.doc-function h3.doc-heading span:nth-child(n+2) {
+    color: var(--md-code-hl-name-color) !important;
+}
 
 .indent {
     margin-left: 1rem;

docs/examples.md

@@ -4,56 +4,57 @@ This page has a few examples to get you familiar with Starplot and how it works.
 2. [Star Chart with an Extra Object Plotted](#star-chart-with-an-extra-object-plotted)
 3. [Map of Orion](#map-of-orion)
 4. [Map of The Pleiades with a Scope Field of View](#map-of-the-pleiades-with-a-scope-field-of-view)
+5. [Optic plot of The Pleiades with a Refractor Telescope](#optic-plot-of-the-pleiades-with-a-refractor-telescope)
 
 
 
 ## Star Chart for Time/Location
 To create a star chart for the sky as seen from [Palomar Mountain](https://en.wikipedia.org/wiki/Palomar_Mountain) in California on July 13, 2023 at 10pm PT:
 
 ```python
-{% include 'examples/example_1.py' %}
+{% include 'examples/example_01.py' %}
 ```
 
 The created file should look like this:
 
-![starchart-blue](images/example_1.png)
+![starchart-blue](images/example_01.png)
 
 
 ## Star Chart with an Extra Object Plotted
 
 Building on the first example, you can also plot additional objects and even customize their style. Here's an example that plots the [Coma Star Cluster](https://en.wikipedia.org/wiki/Coma_Star_Cluster) (Melotte 111) as a red star and also changes the plot style to `GRAYSCALE`:
 
 ```python
-{% include 'examples/example_2.py' %}
+{% include 'examples/example_02.py' %}
 ```
 
-![zenith-coma](images/example_2.png)
+![zenith-coma](images/example_02.png)
 
 
 ## Map of Orion
 
 The following code will create a simple map plot that shows the area around the constellation Orion, including a legend and an extra marker for M42 - [The Great Orion Nebula](https://en.wikipedia.org/wiki/Orion_Nebula):
 
 ```python
-{% include 'examples/example_3.py' %}
+{% include 'examples/example_03.py' %}
 ```
 
 The result should look like this:
 
-![map-orion](images/example_3.png)
+![map-orion](images/example_03.png)
 
 
 ## Map of The Pleiades with a Scope Field of View
 
 The following code will create a minimal map plot that shows the field of view (red dashed circle) of [The Pleiades (M45)](https://en.wikipedia.org/wiki/Pleiades) when looking through a [Tele Vue 85](https://www.televue.com/engine/TV3b_page.asp?id=26) telescope with a 14mm eyepiece that has a 82 degree FOV:
 
 ```python
-{% include 'examples/example_4.py' %}
+{% include 'examples/example_04.py' %}
 ```
 
 The result should look like this:
 
-![map-pleiades-scope](images/example_4.png)
+![map-pleiades-scope](images/example_04.png)
 
 !!! tip "Binocular Field of View"
 
@@ -63,6 +64,21 @@ The result should look like this:
     p.plot_bino_fov(ra=3.78361, dec=24.11667, fov=65, magnification=10)
     ```
 
+
+## Optic plot of The Pleiades with a Refractor Telescope
+
+The following code will create an optic plot that shows what The Pleiades looked like through a refractor telescope on December 16, 2023 at 9pm PT from Palomar Mountain in California.
+
+```python
+{% include 'examples/example_05.py' %}
+```
+
+The result should look like this:
+
+![optic-m45](images/example_05.png)
+
+
+
 ---
 
 *Check out the code reference to learn more about using starplot!*