From 45e3d9337205e3b188490eaf05f4de9a27b0714e Mon Sep 17 00:00:00 2001 From: "Michael S. P. Kelley" Date: Mon, 12 Jun 2023 11:05:43 -0400 Subject: [PATCH 1/6] Document all changes. --- CHANGES.rst | 49 +++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 39 insertions(+), 10 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 72c722aa..da8d8781 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,10 +1,12 @@ 0.4.0 (release date TBD) ======================== -* Dropped support for Python 3.7, minimum supported version is 3.8. - -* Bumped minimum supported versions for `numpy` to 1.18, `astropy` to 4.3, `synphot` - to 1.1, `astroquery` to 4.6. +* Updated minimum supported versions: + - Python 3.8 + - `numpy` 1.18 + - `astropy` 4.3 + - `synphot` 1.1 + - `astroquery` 0.4.5 New Features @@ -21,20 +23,25 @@ sbpy.activity ``VMGridParams``, ``VMFragment``, and ``VMParent`` dataclasses to expose details of ``VectorialModel`` results that may be of interest. [#336] +sbpy.calib +^^^^^^^^^^ + +- Added a model spectrum of the Sun from STScI's CALSPEC database (Bohlin et al. + 2014, PASP 126, 711, DOI:10.1086/677655). + sbpy.data ^^^^^^^^^ -- Added ``Orbit.tisserand`` to calculate the Tisserand parameter of small - body's orbits with respect to planets. [#325] +- Added ``Orbit.tisserand`` to calculate the Tisserand parameter of small body's + orbits with respect to planets. [#325] -- Added ``Orbit.D_criterion`` to evaluate the D-criterion between two sets - of orbital elements. [#325] +- Added ``Orbit.D_criterion`` to evaluate the D-criterion between two sets of + orbital elements. [#325] - Added ``DataClass.__contains__`` to enable `in` operator for ``DataClass`` objects. [#357] -- Added ``DataClass.add_row``, ``DataClass.vstack`` - methods. [#367] +- Added ``DataClass.add_row``, ``DataClass.vstack`` methods. [#367] sbpy.photometry ^^^^^^^^^^^^^^^ @@ -42,6 +49,23 @@ sbpy.photometry - Added parameter constraints to the IAU disk-integrated phase function models, such as ``HG``, ``HG1G2``, ``HG12``, and ``HG12_Pen16``. [#366] +Documentation +^^^^^^^^^^^^^ + +- Index page has been reorganized. + + +API Changes +----------- + +sbpy.data +^^^^^^^^^ + +- IAU HG series functions moved from `sbpy.data.core` to `sbpy.data.iau`. + +sbpy.photometry +^^^^^^^^^^^^^^^ + - Replaced ``NonmonotonicPhaseFunctionWarning`` with ``InvalidPhaseFunctionWarning``. [#366] @@ -49,6 +73,11 @@ sbpy.photometry Bug Fixes --------- +sbpy.calib +^^^^^^^^^^ + +- Updated STScI URLs for solar spectra (Castelli and Kurucz models). + sbpy.data ^^^^^^^^^ From 73adb7da40b389068181ed7cd525887714ec27c6 Mon Sep 17 00:00:00 2001 From: "Michael S. P. Kelley" Date: Sat, 17 Jun 2023 10:01:56 -0400 Subject: [PATCH 2/6] Link check: update URLs --- docs/about.rst | 8 ++++---- docs/development/index.rst | 4 ++-- docs/index.rst | 2 +- docs/install.rst | 2 +- docs/sbpy/data/ephem.rst | 2 +- docs/sbpy/data/orbit.rst | 2 +- docs/sbpy/data/phys.rst | 2 +- docs/status.rst | 2 +- sbpy/data/obs.py | 2 +- sbpy/data/orbit.py | 4 ++-- 10 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/about.rst b/docs/about.rst index dc8ce58d..f1d21791 100644 --- a/docs/about.rst +++ b/docs/about.rst @@ -311,7 +311,7 @@ are always given in km. This makes sense for large objects - but what about meter-sized objects like near-Earth asteroids? Following the -`Zen of Python `_ (explicit +`Zen of Python `_ (explicit is better than implicit), we require that units are explicitly defined: @@ -389,16 +389,16 @@ methods. -.. _JPL Horizons: https://ssd.jpl.nasa.gov/horizons.cgi +.. _JPL Horizons: https://ssd.jpl.nasa.gov/horizons/ .. _Minor Planet Center: https://minorplanetcenter.net/ .. _IMCCE: http://vo.imcce.fr/webservices/miriade/ -.. _Lowell Observatory: https://asteroid.lowell.edu +.. _Lowell Observatory: https://asteroid.lowell.edu/gui/ .. _PyEphem: https://rhodesmill.org/pyephem .. _REBOUND: https://github.com/hannorein/rebound .. _OpenOrb: https://github.com/oorb/oorb .. _SpiceyPy: https://github.com/AndrewAnnex/SpiceyPy .. _web-API: https://minorplanetcenter.net/search_db -.. _Solar System Object Image Search function of the Canadian Astronomy Data Centre: http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/en/ssois/ +.. _Solar System Object Image Search function of the Canadian Astronomy Data Centre: https://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/en/ssois/ .. _skybot: http://vo.imcce.fr/webservices/skybot/ .. _small bodies data ferret: https://sbnapps.psi.edu/ferret .. _github wiki: https://github.com/mommermi/sbpy/wiki diff --git a/docs/development/index.rst b/docs/development/index.rst index 32197ff4..951b8d22 100644 --- a/docs/development/index.rst +++ b/docs/development/index.rst @@ -15,7 +15,7 @@ Communicating with the developers We would prefer any communication with the development team to go through the `github issue system -`_. This way, all +`_. This way, all communications are centralized in one place and accessible to everyone. `sbpy` issues can be posted `here `__. @@ -96,7 +96,7 @@ Technical requirements * code must adhere to `astropy's contributing guidelines `__, the guidelines described in this document and `PEP8 - `_ + `_ * code must be accompanied by corresponding tests; 100% of the implemented tests must pass, a test coverage >= 90% is required; if possible, results should be checked against results from the diff --git a/docs/index.rst b/docs/index.rst index cb7651c8..99f5c10c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,7 +34,7 @@ Current Status :alt: GitHub testing status .. image:: https://codecov.io/gh/NASA-Planetary-Science/sbpy/branch/main/graph/badge.svg - :target: https://codecov.io/gh/NASA-Planetary-Science/sbpy + :target: https://app.codecov.io/gh/NASA-Planetary-Science/sbpy :alt: codecov status diff --git a/docs/install.rst b/docs/install.rst index a418e433..e62fd225 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -12,7 +12,7 @@ care of with installation using pip: * `numpy `__ 1.17.0 or later * `astropy `__ 4.0 or later * `astroquery `__ 0.4.5 or later: For retrieval of online data, e.g., ephemerides and orbits. -* `scipy `__: For numerical integrations in `sbpy.activity.gas` and `sbpy.photometry`, among others. +* `scipy `__: For numerical integrations in `sbpy.activity.gas` and `sbpy.photometry`, among others. * `synphot `__ 1.0.0 or later: For calibration with respect to the Sun and Vega, filtering spectra through bandpasses. Optional dependencies diff --git a/docs/sbpy/data/ephem.rst b/docs/sbpy/data/ephem.rst index aaf29fbe..18eb84e3 100644 --- a/docs/sbpy/data/ephem.rst +++ b/docs/sbpy/data/ephem.rst @@ -14,7 +14,7 @@ JPL Horizons (`~sbpy.data.Ephem.from_horizons`) location, and the ephemeris epoch. For instance, the following few lines will query for ephemerides of asteroid Ceres on a given date and for the position of Mauna Kea Observatory (IAU observatory code 568) from the `JPL Horizons service -`_: +`_: .. doctest-remote-data:: diff --git a/docs/sbpy/data/orbit.rst b/docs/sbpy/data/orbit.rst index c2a38ad6..3c35a7bd 100644 --- a/docs/sbpy/data/orbit.rst +++ b/docs/sbpy/data/orbit.rst @@ -7,7 +7,7 @@ Orbit Queries `~sbpy.data.Orbit.from_horizons` enables the query of Solar System body osculating elements from the `JPL Horizons service -`_: +`_: .. doctest-remote-data:: diff --git a/docs/sbpy/data/phys.rst b/docs/sbpy/data/phys.rst index 116f1f76..60300e26 100644 --- a/docs/sbpy/data/phys.rst +++ b/docs/sbpy/data/phys.rst @@ -5,7 +5,7 @@ Physical Data Objects (`sbpy.data.Phys`) `~sbpy.data.Phys` is designed to contain and query physical properties for small bodies; functions to query these properties are available. `~sbpy.data.Phys.from_sbdb` queries the `JPL Small-body -Database Browser (SBDB) `_ for physical +Database Browser (SBDB) `_ for physical properties and stores the data in a `~sbpy.data.Phys` object, offering the same functionality as all the other `~sbpy.data` functions, including the use of `~astropy.units`. diff --git a/docs/status.rst b/docs/status.rst index f4f931e0..87d3f023 100644 --- a/docs/status.rst +++ b/docs/status.rst @@ -13,7 +13,7 @@ The current development version is **v0.4dev**; its status is as follows: :alt: GitHub testing status .. image:: https://codecov.io/gh/NASA-Planetary-Science/sbpy/branch/main/graph/badge.svg - :target: https://codecov.io/gh/NASA-Planetary-Science/sbpy + :target: https://app.codecov.io/gh/NASA-Planetary-Science/sbpy :alt: codecov status .. image:: https://readthedocs.org/projects/sbpy/badge/?version=latest diff --git a/sbpy/data/obs.py b/sbpy/data/obs.py index cfb192d8..23ad875c 100644 --- a/sbpy/data/obs.py +++ b/sbpy/data/obs.py @@ -107,7 +107,7 @@ def supplement(self, service='jplhorizons', id_field='targetname', service : str, optional Service from which to acquire data: ``'jplhorizons'``, ``'mpc'``, or ``'miriade'``, corresponding to the - `JPL Horizons system `_ + `JPL Horizons system `_ (using `~sbpy.data.Ephem.from_horizons`), the `Minor Planet Center ephemeris service `_ diff --git a/sbpy/data/orbit.py b/sbpy/data/orbit.py index 6eccf846..a06a768b 100644 --- a/sbpy/data/orbit.py +++ b/sbpy/data/orbit.py @@ -57,7 +57,7 @@ def from_horizons(cls, targetids, id_type='smallbody', epochs=None, center='500@10', **kwargs): """Load target orbital elements from - `JPL Horizons `_ using + `JPL Horizons `_ using `astroquery.jplhorizons.HorizonsClass.elements` Parameters @@ -102,7 +102,7 @@ def from_horizons(cls, targetids, id_type='smallbody', ----- * For detailed explanations of the queried fields, refer to `astroquery.jplhorizons.HorizonsClass.elements` and the - `JPL Horizons documentation `_. + `JPL Horizons documentation `_. * By default, elements are provided in the J2000.0 reference system and relative to the ecliptic and mean equinox of the reference epoch. Different settings can be chosen using From d0dbade568829488d0e50a99e0b2eac5272d8495 Mon Sep 17 00:00:00 2001 From: "Michael S. P. Kelley" Date: Sat, 17 Jun 2023 10:13:59 -0400 Subject: [PATCH 3/6] Update sub-module status page. --- docs/status.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/status.rst b/docs/status.rst index 87d3f023..bfeb439d 100644 --- a/docs/status.rst +++ b/docs/status.rst @@ -4,9 +4,9 @@ Status Page =========== This page indicates the development status of `sbpy`. The development -is expected to conclude in 2021. +is expected to conclude in 2024. -The current development version is **v0.4dev**; its status is as follows: +The current development version is **v0.5.dev**; its status is as follows: .. image:: https://github.com/NASA-Planetary-Science/sbpy/actions/workflows/ci_cron_weekly.yml/badge.svg :target: https://github.com/NASA-Planetary-Science/sbpy/actions @@ -237,13 +237,13 @@ classes. sbpy.activity.gas - + MSK / MdVB - Haser model implemented; Vectorial model partially tested; + Haser and Vectorial models implemented From 851a7c1619ae51cda68068f4a63798dfca5a821e Mon Sep 17 00:00:00 2001 From: "Michael S. P. Kelley" Date: Sat, 17 Jun 2023 10:39:12 -0400 Subject: [PATCH 4/6] Set release date. --- CHANGES.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index da8d8781..2d7f9311 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,5 +1,5 @@ -0.4.0 (release date TBD) -======================== +0.4.0 (2023-06-17) +================== * Updated minimum supported versions: - Python 3.8 From 6e945dfdd4641cbd94d6dd51f16e94c046d56c8a Mon Sep 17 00:00:00 2001 From: "Michael S. P. Kelley" Date: Fri, 30 Jun 2023 09:41:56 -0400 Subject: [PATCH 5/6] Update requirements in docs. --- docs/install.rst | 15 ++++++++------- setup.cfg | 1 + 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index e62fd225..aaebd1cb 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -8,12 +8,13 @@ Requirements `sbpy` has the following requirements that will be automatically taken care of with installation using pip: -* Python 3.7 or later -* `numpy `__ 1.17.0 or later -* `astropy `__ 4.0 or later -* `astroquery `__ 0.4.5 or later: For retrieval of online data, e.g., ephemerides and orbits. -* `scipy `__: For numerical integrations in `sbpy.activity.gas` and `sbpy.photometry`, among others. -* `synphot `__ 1.0.0 or later: For calibration with respect to the Sun and Vega, filtering spectra through bandpasses. +* Python 3.8 or later +* `ads `__ 0.12 or later, to fetch citation details for bibliography tracking. +* `astropy `__ 4.3 or later. +* `astroquery `__ 0.4.5 or later, for retrieval of online data, e.g., ephemerides and orbits. +* `numpy `__ 1.18 or later. +* `scipy `__: 1.3 or later, for numerical integrations in `sbpy.activity.gas` and `sbpy.photometry`, among others. +* `synphot `__ 1.1.1 or later, for calibration with respect to the Sun and Vega, filtering spectra through bandpasses. Optional dependencies ^^^^^^^^^^^^^^^^^^^^^ @@ -23,7 +24,7 @@ Optional dependencies (`~sbpy.data.Orbit.oo_propagate`), as well as ephemerides calculations (`~sbpy.data.Ephem.from_oo`). * `pyradex `__: For non-LTE production - rate calculation related to cometary activity (`~sbpy.activity.gas.NonLTE`). + rate calculations related to cometary activity (`~sbpy.activity.gas.NonLTE`). * `ginga `__ and `photutils `__: To interactively enhance images of comets with the `~sbpy.imageanalysis.CometaryEnhancement` Ginga diff --git a/setup.cfg b/setup.cfg index 3bc5d57e..9c8dbb5f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -27,6 +27,7 @@ packages = find: zip_save = False python_requires = >=3.8 setup_requires = setuptools_scm +# keep requirements in synchronization with docs/install.rst install_requires = numpy>=1.18.0 astropy>=4.3 From 343786a1a6ed36931e3a7f379876d64f57ce9308 Mon Sep 17 00:00:00 2001 From: "Michael S. P. Kelley" Date: Fri, 30 Jun 2023 09:42:04 -0400 Subject: [PATCH 6/6] Fix mistakes in changes. --- CHANGES.rst | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 2d7f9311..38358e53 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,4 +1,4 @@ -0.4.0 (2023-06-17) +0.4.0 (2023-06-30) ================== * Updated minimum supported versions: @@ -27,7 +27,7 @@ sbpy.calib ^^^^^^^^^^ - Added a model spectrum of the Sun from STScI's CALSPEC database (Bohlin et al. - 2014, PASP 126, 711, DOI:10.1086/677655). + 2014, PASP 126, 711, DOI:10.1086/677655). [#371] sbpy.data ^^^^^^^^^ @@ -52,16 +52,21 @@ sbpy.photometry Documentation ^^^^^^^^^^^^^ -- Index page has been reorganized. +- Index page has been reorganized. [#337] API Changes ----------- +sbpy.activity +^^^^^^^^^^^^^ + +- ``VectorialModel`` now no longer takes an ``angular_substeps`` parameter. [#336] + sbpy.data ^^^^^^^^^ -- IAU HG series functions moved from `sbpy.data.core` to `sbpy.data.iau`. +- IAU HG series functions moved from `sbpy.photometry.core` to `sbpy.photometry.iau`. [#354] sbpy.photometry ^^^^^^^^^^^^^^^ @@ -76,7 +81,7 @@ Bug Fixes sbpy.calib ^^^^^^^^^^ -- Updated STScI URLs for solar spectra (Castelli and Kurucz models). +- Updated STScI URLs for solar spectra (Castelli and Kurucz models). [#345] sbpy.data ^^^^^^^^^ @@ -89,15 +94,6 @@ sbpy.data designations: they do not parse as cometary or asteroidal. [#334, #340] -API Changes ------------ - -sbpy.activity -^^^^^^^^^^^^^ - -- ``VectorialModel`` now no longer takes an ``angular_substeps`` parameter. [#336] - - 0.3.0 (2022-04-28) ==================