starplot 0.11.3__tar.gz → 0.12.0__tar.gz

{starplot-0.11.3 → starplot-0.12.0}/.gitignore

@@ -7,6 +7,7 @@ de421.bsp
 hip_main.dat
 hip8.dat
 CometEls.txt
+ongc.gpkg
 
 # Big Sky - Full Catalog
 # we ignore this because of its size (50+ MB)

{starplot-0.11.3 → starplot-0.12.0}/Makefile

@@ -70,6 +70,12 @@ 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"
+
+prep-constellations:
+	$(DOCKER_RUN) "python -m starplot.data.prep.constellations"
+
 version:
 	@$(DOCKER_RUN) "python -c 'import starplot as sp; print(sp.__version__)'"
 

{starplot-0.11.3 → starplot-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: starplot
-Version: 0.11.3
+Version: 0.12.0
 Summary: Star charts and maps
 Keywords: astronomy,stars,charts,maps,constellations
 Author-email: Steve Berardi <hello@steveberardi.com>
@@ -104,23 +104,14 @@ https://discord.gg/WewJJjshFu
 
 Contributing to Starplot is welcome and very much appreciated! Please see [here](CONTRIBUTING.md) for details.
 
-## Core Dependencies
-
-- matplotlib
-- pandas
-- numpy
-- geopandas
-- cartopy
-- skyfield
-- pydantic
-- adjustText
-
 ## Coming Soon
 - 🌑 Planet moons
 - ✴️ Custom markers
 - 🚀 Plotting Optimizations
-- 📐 Custom clip paths
+- ☄️ Comet model
+- 🌄 Horizon plots
 - ⚖️ Better auto font-size adjustment
+- 😄 🔭 Clear skies
 
 See more details on the [Public Roadmap](https://trello.com/b/sUksygn4/starplot-roadmap)
 

{starplot-0.11.3 → starplot-0.12.0}/README.md

@@ -71,23 +71,14 @@ https://discord.gg/WewJJjshFu
 
 Contributing to Starplot is welcome and very much appreciated! Please see [here](CONTRIBUTING.md) for details.
 
-## Core Dependencies
-
-- matplotlib
-- pandas
-- numpy
-- geopandas
-- cartopy
-- skyfield
-- pydantic
-- adjustText
-
 ## Coming Soon
 - 🌑 Planet moons
 - ✴️ Custom markers
 - 🚀 Plotting Optimizations
-- 📐 Custom clip paths
+- ☄️ Comet model
+- 🌄 Horizon plots
 - ⚖️ Better auto font-size adjustment
+- 😄 🔭 Clear skies
 
 See more details on the [Public Roadmap](https://trello.com/b/sUksygn4/starplot-roadmap)
 

{starplot-0.11.3 → starplot-0.12.0}/docs/changelog.md

@@ -1,5 +1,16 @@
+## v0.12.x
+
+- Adds Shapely geometry to all sky object models, including support for `intersects` in `where` clauses
+- Adds kwarg to map plots to allow custom clip paths
+- Adds callables for star/dso labels
+- Adds a `line` function for plotting lines
+- Adds the standard marker for globular clusters (circle with a cross) and double stars
+- Adds an ellipse marker for galaxies
+- Adds colors for some DSO labels that were missing them in some style extensions
+- Removed the kwarg `types` from `dsos`, so ALL DSO types are plotted by default
 
 ## v0.11.x
+[Documentation](https://archives.starplot.dev/0.11.4/)
 
 - Replaces Tycho-1 stars with an abridged version of the [Big Sky Catalog](https://github.com/steveberardi/bigsky)
 - Adds style option for a star's edge color (previously this was forced to be the background color)
@@ -12,12 +23,10 @@
 - Adds TYC id to stars (if available)
 - Adds the following projections: Robinson, Lambert Azimuthal Equal-Area
 - Adds a constellation model, allowing you to selectively plot objects by their constellation
-- [**v0.11.1**]
-    - Fixes default horizon style to be consistent with grayscale extension
-- [**v0.11.2**]
-    - Adds `requests` as a required dependency
-- [**v0.11.3**]
-    - Fixes bug with plotting the celestial equator
+- [**v0.11.1**] Fixes default horizon style to be consistent with grayscale extension
+- [**v0.11.2**] Adds `requests` as a required dependency
+- [**v0.11.3**] Fixes bug with plotting the celestial equator
+- [**v0.11.4**] Fixes bug with filtering DSOs by NGC/IC identifier
 
 ## v0.10.x
 [Documentation](https://archives.starplot.dev/0.10.2/)

{starplot-0.11.3 → starplot-0.12.0}/docs/coming-soon.md

@@ -1,8 +1,9 @@
 
 - 🌑 Planet moons
+- ☄️ Comet model
+- 🌄 Horizon plots
 - ✴️ Custom markers
 - 🚀 Plotting Optimizations
-- 📐 Custom clip paths
 - ⚖️ Better auto font-size adjustment
 - 😄 🔭 Clear skies
 

{starplot-0.11.3 → starplot-0.12.0}/docs/data-sources.md

@@ -19,3 +19,5 @@
 
 ### **Milky Way Outline**
 - Created by Steve Berardi with QGIS + GDAL from NASA's [Deep Star Maps](https://svs.gsfc.nasa.gov/4851)
+
+<br/><br/>

starplot-0.12.0/docs/examples/map-canis-major.md

@@ -0,0 +1,14 @@
+---
+title: Map of Canis Major
+---
+[:octicons-arrow-left-24: Back to Examples](/examples)
+
+# Map of Canis Major {.example-header}
+
+![map-canis-major](/images/examples/map_canis_major.png)
+
+```python
+--8<-- "examples/map_canis_major.py"
+```
+
+

{starplot-0.11.3 → starplot-0.12.0}/docs/examples.md

@@ -106,6 +106,14 @@
         </a>
     </li>
 
+    <li>
+        <a href="/examples/map-canis-major">
+            <img src="/images/examples/map_canis_major-sm.png" alt="Map of the Constellation Canis Major" class="off-glb" loading="lazy"/>
+
+            <p class="example-card-title">Map of Canis Major</p>
+        </a>
+    </li>
+
 </ul>
 
 

{starplot-0.11.3 → starplot-0.12.0}/docs/reference-callables.md

@@ -1,4 +1,4 @@
-Callables allow you to define your own functions for calculating a few of the style properties for stars: size, alpha (opacity), and color. DSOs support callables for alpha only. Starplot has a few basic callables built-in, but you can also create your own.
+Callables allow you to define your own functions for calculating a few of the style properties for stars: size, alpha (opacity), color, and the star's label. DSOs support callables for alpha and labels only. Starplot has a few basic callables built-in, but you can also create your own.
 
 ???- tip "What's a Callable?"
 

{starplot-0.11.3 → starplot-0.12.0}/docs/reference-data.md

@@ -16,7 +16,7 @@
         show_docstring_attributes: true
         members: true
 
-::: starplot.data.dsos.DEFAULT_DSO_TYPES
+::: starplot.data.dsos.BASIC_DSO_TYPES
     options:
         show_root_heading: true
         show_docstring_attributes: true

{starplot-0.11.3 → starplot-0.12.0}/docs/reference-selecting-objects.md

@@ -39,6 +39,7 @@ On line 16, we plot only the DSOs we want by passing the `where` keyword argumen
 | `(Star.hip.is_not_null()) | (Star.bv < 0)`       | Select stars that have a HIP id **OR** have a bluish color (bv < 0)       |
 | `Star.name.is_in(["Sirius", "Rigel", "Vega"])`   | Select stars with the names Sirius, Rigel, or Vega                        |
 | `(DSO.size.is_null()) | (DSO.size > 0.01)`       | Select DSOs that have no defined size **OR** are larger than 0.01 square degrees      |
+| `Star.geometry.intersects(m45.geometry)`         | Select stars that are within the Pleiades (M45) star cluster (assumes `m45 = DSO.get(m='45')`)     |
 
 ## Important Details
 

{starplot-0.11.3 → starplot-0.12.0}/docs/reference-styling.md

@@ -292,6 +292,12 @@ When you only want to override one or two style properties, it can be tedious to
         show_docstring_attributes: true
         members: true
 
+::: starplot.styles.ZOrderEnum
+    options:
+        show_root_heading: true
+        show_docstring_attributes: true
+        members: true
+
 ---
 
 ## Style Extensions

starplot-0.12.0/docs/tutorial/03.md

@@ -0,0 +1,40 @@
+---
+title: 3 - Adding More Details to the Star Chart
+---
+
+---
+
+<figure markdown="span">
+  ![Tutorial - Detailed Star Chart](/images/tutorial/tutorial_03.png){ width="600" }
+</figure>
+
+Building on the first example, let's add some color and more objects to the plot, to create the chart above. Here's the revised code with comments explaining the new lines:
+
+<div class="tutorial">
+```python  linenums="1"
+--8<-- "tutorial/tutorial_03.py"
+```
+</div>
+
+Here are some more details about what we changed:
+
+- **Customized the style** by adding the `style` keyword argument when creating the plot instance. This is an instance of a [`PlotStyle`][starplot.PlotStyle], and it represents ALL the styling properties to use for the plot (e.g. the colors, symbols, sizes, and more). In our revised example here, we create a default `PlotStyle` and then `extend` it with the `BLUE_MEDIUM` color scheme. Starplot has a very customizable [styling framework](/reference-styling) that allows you to customize the appearance of just about anything you plot.
+
+- **Plotted deep sky objects (DSOs)** with a limiting magnitude of 9. The `true_size=False` argument tells Starplot to plot each DSO's size based on what's specified in the style definition and NOT their true apparent size. For zenith plots like this one, plotting the true size can make many DSOs too small to see on the plot. We also pass `labels=None` to hide all the labels for DSOs to avoid cluttering the plot.
+
+- **Plotted other lines and objects:** constellation borders, ecliptic, celestial equator, and the Milky Way.
+
+- **Added a marker for the [Coma Star Cluster](https://en.wikipedia.org/wiki/Coma_Star_Cluster)** (aka Melotte 111), and customized its style. Starplot also has functions for plotting circles, rectangles, polygons, and more. See the reference for [`MapPlot`][starplot.MapPlot] for details.
+
+*In the [next section](04.md), we'll learn how to create maps in other projections...*
+
+---
+<div class="flex-space-between" markdown>
+
+[:octicons-arrow-left-24: Previous](02.md){ .md-button .text-right }
+
+[Tutorial Home](/tutorial)
+
+[Next :octicons-arrow-right-24:](04.md){ .md-button .text-right }
+
+</div>

{starplot-0.11.3 → starplot-0.12.0}/docs/tutorial/08.md

@@ -9,7 +9,7 @@ title: 8 - Using Callables
 </figure>
 
 
-[Callables](/reference-callables/) allow you to define your own functions for calculating a few of the style properties for stars: size, alpha (opacity), and color. DSOs support callables for alpha only. Starplot has a few basic callables built-in, but you can also create your own.
+[Callables](/reference-callables/) allow you to define your own functions for calculating a few of the style properties for stars: size, alpha (opacity),  color, and their labels. DSOs support callables for alpha and labels only. Starplot has a few basic callables built-in, but you can also create your own.
 
 Here's an example that uses the built-in callable `color_by_bv` to create an optic plot of [Antares](https://en.wikipedia.org/wiki/Antares) that colorizes the stars based on their B-V index (Antares B-V is 1.83 so it appears red/orange in the sky):
 <div class="tutorial" markdown>

{starplot-0.11.3 → starplot-0.12.0}/examples/examples.py

@@ -5,7 +5,7 @@ import glob
 import time
 
 from PIL import Image
-from multiprocessing import Pool
+from multiprocessing import Pool, Process
 
 start = time.time()
 
@@ -17,19 +17,44 @@ def thumbnail(filename, max_dimension=900):
     img.save(f"{filename[:-4]}-sm.png", optimize=True)
 
 
-# Run all examples
-for filename in glob.iglob("*.py"):
-    if filename.endswith("examples.py"):
-        continue
+def get_example_names():
+    filenames = []
+
+    for filename in glob.iglob("*.py"):
+        if filename.endswith("examples.py"):
+            continue
+        filenames.append(filename)
+
+    return filenames
+
+
+def run_example(filename):
+    import subprocess
 
-    # if filename != "star_chart_basic.py":
-    #     continue
     print(f"Running {filename}")
-    subprocess.call(f"python {filename}", shell=True)
+
+    subprocess.call(["python", filename])
+
+
+example_files = get_example_names()
+processes = []
+
+with Pool(5) as pool:
+    pool.map(run_example, example_files)
+
+# Run all examples
+# for filename in glob.iglob("*.py"):
+#     if filename.endswith("examples.py"):
+#         continue
+
+#     # if filename != "map_lyra.py":
+#     #     continue
+#     print(f"Running {filename}")
+#     subprocess.call(f"python {filename}", shell=True)
 
 # Create thumbnail images for the examples list page
 image_files = glob.glob("*.png")
-pool = Pool(8)
+pool = Pool(5)
 results = pool.map(thumbnail, image_files)
 
 # Copy all images to docs directory

starplot-0.12.0/examples/map_canis_major.py

@@ -0,0 +1,37 @@
+from starplot import MapPlot, Projection, Constellation
+from starplot.styles import PlotStyle, extensions
+
+style = PlotStyle().extend(
+    extensions.CB_WONG,
+    extensions.MAP,
+    {
+        "star": {"marker": {"size": 40}, "label": {"font_size": 13}},
+        "bayer_labels": {
+            "font_name": "GFS Didot",  # use a better font for Greek letters
+            "font_size": 10,
+            "font_alpha": 0.9,
+        },
+        "dso_open_cluster": {"marker": {"size": 20}, "label": {"font_size": 10}},
+    },
+)
+canis_major = Constellation.get(name="Canis Major")
+p = MapPlot(
+    projection=Projection.MILLER,
+    ra_min=6,
+    ra_max=7.6,
+    dec_min=-35,
+    dec_max=-9,
+    style=style,
+    resolution=2000,
+    clip_path=canis_major.boundary,
+)
+p.open_clusters(mag=8, true_size=False, label_fn=lambda d: f"{d.ngc}")
+p.stars(mag=9, bayer_labels=True, catalog="big-sky-mag11")
+p.constellations(
+    where=[Constellation.iau_id == "cma"],
+    style__line__width=7,
+    style__label__font_size=18,
+)
+p.constellation_borders()
+p.ax.set_axis_off()
+p.export("map_canis_major.png", padding=0, transparent=True)

{starplot-0.11.3 → starplot-0.12.0}/examples/map_orion.py

@@ -29,7 +29,8 @@ p = MapPlot(
 )
 p.gridlines()
 p.stars(mag=9, bayer_labels=True)
-p.dsos(mag=9, labels=None)
+p.open_clusters(mag=9, labels=None)
+p.nebula(mag=9, labels=None)
 p.constellations()
 p.constellation_borders()
 p.milky_way()

{starplot-0.11.3 → starplot-0.12.0}/examples/map_orthographic.py

@@ -1,6 +1,7 @@
 from datetime import datetime
 from pytz import timezone
-from starplot import MapPlot, Projection, Star
+
+from starplot import MapPlot, Projection, Star, DSO
 from starplot.data import constellations
 from starplot.styles import PlotStyle, extensions
 
@@ -27,11 +28,12 @@ p = MapPlot(
 )
 p.gridlines(labels=False)
 p.stars(mag=7.86, where_labels=[Star.magnitude < 6])
-p.open_clusters(mag=8, true_size=False, labels=None)
-p.galaxies(mag=8, true_size=False, labels=None)
-p.nebula(mag=8, true_size=True, labels=None)
+
+p.open_clusters(where=[DSO.magnitude < 12], true_size=False, labels=None)
+p.galaxies(where=[DSO.magnitude < 12], true_size=False, labels=None)
+p.nebula(where=[DSO.magnitude < 12], true_size=False, labels=None)
+
 p.constellations(
-    labels=constellations.CONSTELLATIONS_FULL_NAMES,
     style={"label": {"font_size": 9, "font_alpha": 0.8}},
 )
 p.constellation_borders()

{starplot-0.11.3 → starplot-0.12.0}/examples/map_sagittarius.py

@@ -47,12 +47,14 @@ p.nebula(
         DSO.magnitude.is_null() | (DSO.magnitude < 12),
     ],
     true_size=True,
+    label_fn=lambda d: d.ic,
 )
 p.open_clusters(
     where=[
         DSO.magnitude.is_null() | (DSO.magnitude < 12),
     ],
     true_size=False,
+    label_fn=lambda d: d.ngc,
 )
 p.constellation_borders()
 p.ecliptic()

{starplot-0.11.3 → starplot-0.12.0}/examples/star_chart_detail.py

@@ -1,6 +1,6 @@
 from datetime import datetime
 from pytz import timezone
-from starplot import MapPlot, Projection, Star
+from starplot import MapPlot, Projection, Star, DSO
 from starplot.styles import PlotStyle, extensions
 
 tz = timezone("America/Los_Angeles")
@@ -19,7 +19,9 @@ p = MapPlot(
 p.constellations()
 p.stars(mag=4.6, where_labels=[Star.magnitude < 2.1])
 
-p.dsos(mag=9, true_size=True, labels=None)
+p.galaxies(where=[DSO.magnitude < 10], true_size=False, labels=None)
+p.open_clusters(where=[DSO.magnitude < 10], true_size=False, labels=None)
+
 p.constellation_borders()
 p.ecliptic()
 p.celestial_equator()

{starplot-0.11.3 → starplot-0.12.0}/hash_checks/hashio.py

@@ -1,8 +1,8 @@
 import sys
 import inspect
 import time
+import multiprocessing as mp
 
-from multiprocessing import Pool
 from pathlib import Path
 
 import imagehash
@@ -87,9 +87,10 @@ class Hashio:
 
     def _get_hashes(self) -> dict:
         """Gets hashes for all callables"""
+        mp.set_start_method("spawn")  # required for M1 macs? or macOS issue?
 
         console.print("Getting hashes...", style="bold")
-        with Pool(5) as p:
+        with mp.Pool(5) as p:
             results = p.map(self._call_wrapper, self.callables)
 
         return {func_name: hashes for func_name, hashes in results}

{starplot-0.11.3 → starplot-0.12.0}/hash_checks/hashlock.yml

@@ -1,7 +1,7 @@
 map_coma_berenices_dso_size:
-  dhash: c4a4a292c8a084a080a69292caa2948484aeb2928ea28682
+  dhash: c2809292c88084a080829292c8828280868a92928a828282
   filename: /starplot/hash_checks/data/map-coma-berenices-dso-size.png
-  phash: c56d36963a696992
+  phash: c16916963e696d96
 map_custom_stars:
   dhash: 5cb129ceae2e84285cb129ceae2e84285cb129ceae2e8428
   filename: /starplot/hash_checks/data/map-custom-stars.png
@@ -10,42 +10,50 @@ map_gridlines:
   dhash: 34318517b2c0902034318517b2c0902034318517b2c09020
   filename: /starplot/hash_checks/data/map-gridlines.png
   phash: f82acf9c3c616392
+map_label_callables:
+  dhash: 80948c8c9c8c88a080988c8c9c8c88a0809c8d0d9d9c98a0
+  filename: /starplot/hash_checks/data/map-m45-label-callables.png
+  phash: b26ccd99316664cd
 map_mollweide:
-  dhash: 0b2973632b33170f0b2973632b33170f0f297b6323330707
+  dhash: 0f2933632b3317070f2933632b3317070f295b6323130707
   filename: /starplot/hash_checks/data/map-mollweide.png
-  phash: fa9ab698c0259567
+  phash: fa9af698c0259566
 map_moon_phase_waxing_crescent:
   dhash: 8884484d4d4884888884484d4d4884888884484d4d488488
   filename: /starplot/hash_checks/data/map-moon-phase-waxing-crescent.png
   phash: b3cccc3333cccc31
 map_orion_base:
-  dhash: 1c3b3b7e6e2f64681c3b3b4e6e2f64681c3b1bce6e2f646c
+  dhash: 1c3b3b6e6e2f64681c3b3b4e6e2f64681c3b1bce6e2f646c
   filename: /starplot/hash_checks/data/map-orion-base.png
   phash: be79d9260785709c
 map_orion_extra:
-  dhash: 1c1b3a6d2f646c171d1b1b6b2f646c871c1b1b6b2d646c07
+  dhash: 1c1b3a6d2f656c171d1b1b6b2f646c871c1b1b6b2d646c07
   filename: /starplot/hash_checks/data/map-orion-extra.png
   phash: be71d11ee01fa4d0
-map_plot_limit_constellation:
-  dhash: 228a869606060202028a8686070606462208869647060a06
-  filename: /starplot/hash_checks/data/map-limit-constellation.png
-  phash: e5699392cc6d6592
+map_plot_custom_clip_path_virgo:
+  dhash: 020103130f0c04040327252d0d0c08040327250f0d0c0804
+  filename: /starplot/hash_checks/data/map-custom-clip-path-virgo.png
+  phash: e66cc983b3919336
+map_plot_limit_by_geometry:
+  dhash: 22a886960c061204028a86960c0a1244122886864c0e0a04
+  filename: /starplot/hash_checks/data/map-limit-by-geometry.png
+  phash: e54d9b926c6d1692
 map_scope_bino_fov:
   dhash: 0bc0808c8c8080802bceb2ac4daa928c2bceb2ac4daa928c
   filename: /starplot/hash_checks/data/map-scope-bino-fov.png
   phash: e46b296a6e693964
 map_stereo_base:
-  dhash: 627666f07c3c3436627666f0282c3416727666f0ac48d416
+  dhash: 627666f07c3c3436627666f0382c3436727666f2ecc89416
   filename: /starplot/hash_checks/data/map-stereo-north-base.png
-  phash: 9dce6973429062fa
+  phash: 9dce7973429062ba
 map_with_planets:
   dhash: 62930d63899b32b362930563899b32b362930563899b32b3
   filename: /starplot/hash_checks/data/map-mercator-planets.png
-  phash: e9c69d89861f5b12
+  phash: e9c69d89861f5392
 map_wrapping:
-  dhash: 16391d2d7743211516391d2d7743211516391d2d77432115
+  dhash: 16391d2d7747211516391d2d7747211516391d2d77472115
   filename: /starplot/hash_checks/data/map-wrapping.png
-  phash: ee30f16d7464213d
+  phash: ee30f1ed3464213d
 optic_camera_rotated:
   dhash: 25468b33269d9a6525468b33269d9a6525468b33269d9a65
   filename: /starplot/hash_checks/data/optic-camera-rotated-m45.png
@@ -65,7 +73,7 @@ optic_m45_camera:
 optic_m45_reflector:
   dhash: 8e173b712b338e4d8e173b712b338e4d8e173b712b338e4d
   filename: /starplot/hash_checks/data/optic-m45-reflector.png
-  phash: bb7b80e486869b93
+  phash: bb7b84e486868b93
 optic_m45_scope:
   dhash: 8e172b5133238e4d8e172b5133238e4d8e172b5133238e4d
   filename: /starplot/hash_checks/data/optic-m45-scope.png
@@ -99,6 +107,6 @@ optic_wrapping:
   filename: /starplot/hash_checks/data/optic-wrapping.png
   phash: d0c46f1b396cf078
 zenith_base:
-  dhash: 1779cc8ad45d3b8e1779cc8a965d2b8e1779ec8a965d2b0e
+  dhash: 1779cc8a945d3b8e1779cc8a965d2b8e1779ec8a965d2b0e
   filename: /starplot/hash_checks/data/zenith-base.png
-  phash: b343eb3be1249664
+  phash: ba43eb3be1249664