From f4d265e5f0ab53c98df95abfc9c134e60c44c433 Mon Sep 17 00:00:00 2001 From: Brandon Rhodes Date: Fri, 24 Jul 2020 06:06:36 -0400 Subject: [PATCH] Finish up docs and declare version 1.25 --- CHANGELOG.rst | 21 ++++++++++++++++----- skyfield/__init__.py | 2 +- skyfield/constellationlib.py | 8 ++++---- skyfield/data/stellarium.py | 4 +++- skyfield/documentation/api.rst | 2 ++ skyfield/documentation/example-plots.rst | 10 ++++++---- 6 files changed, 32 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index aad5fca..fa8ff5d 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,17 +2,28 @@ Changelog ========= -1.25 — 2020 July ? ------------------- +1.25 — 2020 July 24 +------------------- -* Added a routine to load Stellarium constellation lines, - which is featured in a new example script in :doc:`example-plots` - that produces a finder chart for comet C/2020 F3 NEOWISE. +* Added :func:`~skyfield.data.stellarium.parse_constellations()` + and :func:`~skyfield.data.stellarium.parse_star_names()` + to load Stellarium star names and constellation lines. + Constellation lines are featured in a new example script + :ref:`neowise-chart` that produces a finder chart + for comet C/2020 F3 NEOWISE. + +* The Hipparcos star catalog should now load faster, having switched + behind the scenes to a higher performance Pandas import routine. * Fixed the ability of :meth:`~skyfield.timelib.Timescale.utc()` to accept a Python ``datetime.date`` object as its argument. `#409 `_ +* Slightly lowered the precision of two tests when they detect that + Python is compiled for a 32-bit processor, so the test suite can + succeed when contributors package Skyfield for 32-bit Linux. + `#411 `_ + 1.24 — 2020 July 20 ------------------- diff --git a/skyfield/__init__.py b/skyfield/__init__.py index 1460126..06d4037 100644 --- a/skyfield/__init__.py +++ b/skyfield/__init__.py @@ -5,5 +5,5 @@ functions and classes there. See the ``documentation`` directory inside the source code, as well as the http://rhodesmill.org/skyfield/ site! """ -VERSION = (1, 24) +VERSION = (1, 25) __version__ = '.'.join(map(str, VERSION)) diff --git a/skyfield/constellationlib.py b/skyfield/constellationlib.py index 8617f4b..1510cb0 100644 --- a/skyfield/constellationlib.py +++ b/skyfield/constellationlib.py @@ -29,11 +29,11 @@ from .functions import load_bundled_npy from .timelib import Time, julian_date_of_besselian_epoch def load_constellation_map(): - """Load Skyfield's constellation map and return a lookup function + """Load Skyfield's constellation boundaries and return a lookup function. - Skyfield carries an internal constellation map that is optimized for - quick position lookup. Call this function to load the map and - return a function mapping position to constellation name. + Skyfield carries an internal map of constellation boundaries that is + optimized for quick position lookup. Call this function to load the + map and return a function mapping position to constellation name. >>> from skyfield.api import position_of_radec, load_constellation_map >>> constellation_at = load_constellation_map() diff --git a/skyfield/data/stellarium.py b/skyfield/data/stellarium.py index 2107710..3f65c86 100644 --- a/skyfield/data/stellarium.py +++ b/skyfield/data/stellarium.py @@ -17,7 +17,9 @@ def parse_constellations(lines): ] Each name is a 3-letter constellation abbreviation; each star is an - integer Hipparcos catalog number. + integer Hipparcos catalog number. See :ref:`neowise-chart` for an + example of how to combine this data with the Hipparcos star catalog + to draw constellation lines on a chart. """ constellations = [] diff --git a/skyfield/documentation/api.rst b/skyfield/documentation/api.rst index 7a9589b..0d85d50 100644 --- a/skyfield/documentation/api.rst +++ b/skyfield/documentation/api.rst @@ -310,6 +310,8 @@ Constellations ============== .. autofunction:: skyfield.api.load_constellation_map +.. autofunction:: skyfield.data.stellarium.parse_constellations +.. autofunction:: skyfield.data.stellarium.parse_star_names Searching ========= diff --git a/skyfield/documentation/example-plots.rst b/skyfield/documentation/example-plots.rst index ebc3ec7..8f31a9b 100644 --- a/skyfield/documentation/example-plots.rst +++ b/skyfield/documentation/example-plots.rst @@ -19,8 +19,10 @@ these are only intended to be a starting point for building your own scripts, either with matplotlib or whatever other plotting library you prefer. -Finder chart for comet NEOWISE -============================== +.. _neowise-chart: + +Drawing a finder chart for comet NEOWISE +======================================== Here is a stand-alone script that brings together four different data sources — @@ -61,8 +63,8 @@ But the basic data loading and filtering will be the same, so hopefully the script will still help get you started in targeting a more modern plotting library. -Satellite altitude during re-entry -================================== +Plotting satellite altitude during re-entry +=========================================== Here is the decreasing altitude of a satellite as its orbit decayed and it re-entered the atmosphere above the Pacific Ocean: