Skip to content

Commit

Permalink
Merge pull request #375 from mkelley/prepare-v0.4
Browse files Browse the repository at this point in the history
Prepare v0.4 release
  • Loading branch information
mkelley authored Jun 30, 2023
2 parents 39451c6 + 343786a commit 39b0c3c
Show file tree
Hide file tree
Showing 12 changed files with 73 additions and 46 deletions.
67 changes: 46 additions & 21 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
0.4.0 (release date TBD)
========================

* Dropped support for Python 3.7, minimum supported version is 3.8.
0.4.0 (2023-06-30)
==================

* 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
Expand All @@ -21,34 +23,66 @@ 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). [#371]

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
^^^^^^^^^^^^^^^

- 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. [#337]


API Changes
-----------

sbpy.activity
^^^^^^^^^^^^^

- ``VectorialModel`` now no longer takes an ``angular_substeps`` parameter. [#336]

sbpy.data
^^^^^^^^^

- IAU HG series functions moved from `sbpy.photometry.core` to `sbpy.photometry.iau`. [#354]

sbpy.photometry
^^^^^^^^^^^^^^^

- Replaced ``NonmonotonicPhaseFunctionWarning`` with
``InvalidPhaseFunctionWarning``. [#366]


Bug Fixes
---------

sbpy.calib
^^^^^^^^^^

- Updated STScI URLs for solar spectra (Castelli and Kurucz models). [#345]

sbpy.data
^^^^^^^^^

Expand All @@ -60,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)
==================

Expand Down
8 changes: 4 additions & 4 deletions docs/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.python.org/dev/peps/pep-0020/>`_ (explicit
`Zen of Python <https://peps.python.org/pep-0020/>`_ (explicit
is better than implicit), we require that units are explicitly
defined:

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/development/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Communicating with the developers

We would prefer any communication with the development team to go
through the `github issue system
<https://guides.github.com/features/issues/>`_. This way, all
<https://docs.github.com/issues>`_. This way, all
communications are centralized in one place and accessible to
everyone. `sbpy` issues can be posted `here
<https://github.com/NASA-Planetary-Science/sbpy/issues>`__.
Expand Down Expand Up @@ -96,7 +96,7 @@ Technical requirements
* code must adhere to `astropy's contributing guidelines
<https://www.astropy.org/contribute.html>`__, the guidelines
described in this document and `PEP8
<https://www.python.org/dev/peps/pep-0008/>`_
<https://peps.python.org/pep-0008/>`_
* 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
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
15 changes: 8 additions & 7 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://numpy.org/>`__ 1.17.0 or later
* `astropy <https://www.astropy.org/>`__ 4.0 or later
* `astroquery <https://astroquery.readthedocs.io/en/latest/>`__ 0.4.5 or later: For retrieval of online data, e.g., ephemerides and orbits.
* `scipy <https://www.scipy.org/>`__: For numerical integrations in `sbpy.activity.gas` and `sbpy.photometry`, among others.
* `synphot <https://github.com/spacetelescope/synphot_refactor>`__ 1.0.0 or later: For calibration with respect to the Sun and Vega, filtering spectra through bandpasses.
* Python 3.8 or later
* `ads <https://github.com/andycasey/ads/>`__ 0.12 or later, to fetch citation details for bibliography tracking.
* `astropy <https://www.astropy.org/>`__ 4.3 or later.
* `astroquery <https://astroquery.readthedocs.io/en/latest/>`__ 0.4.5 or later, for retrieval of online data, e.g., ephemerides and orbits.
* `numpy <https://numpy.org/>`__ 1.18 or later.
* `scipy <https://scipy.org/>`__: 1.3 or later, for numerical integrations in `sbpy.activity.gas` and `sbpy.photometry`, among others.
* `synphot <https://github.com/spacetelescope/synphot_refactor>`__ 1.1.1 or later, for calibration with respect to the Sun and Vega, filtering spectra through bandpasses.

Optional dependencies
^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -23,7 +24,7 @@ Optional dependencies
(`~sbpy.data.Orbit.oo_propagate`), as well as ephemerides calculations
(`~sbpy.data.Ephem.from_oo`).
* `pyradex <https://github.com/keflavich/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 <https://ejeschke.github.io/ginga/>`__ and `photutils
<https://photutils.readthedocs.io/en/stable/>`__: To interactively enhance
images of comets with the `~sbpy.imageanalysis.CometaryEnhancement` Ginga
Expand Down
2 changes: 1 addition & 1 deletion docs/sbpy/data/ephem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://ssd.jpl.nasa.gov/horizons.cgi>`_:
<https://ssd.jpl.nasa.gov/horizons/>`_:

.. doctest-remote-data::

Expand Down
2 changes: 1 addition & 1 deletion docs/sbpy/data/orbit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://ssd.jpl.nasa.gov/horizons.cgi>`_:
<https://ssd.jpl.nasa.gov/horizons/>`_:

.. doctest-remote-data::

Expand Down
2 changes: 1 addition & 1 deletion docs/sbpy/data/phys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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) <https://ssd.jpl.nasa.gov/sbdb.cgi>`_ for physical
Database Browser (SBDB) <https://ssd.jpl.nasa.gov/tools/sbdb_lookup.html>`_ 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`.
Expand Down
10 changes: 5 additions & 5 deletions docs/status.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ 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
: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
Expand Down Expand Up @@ -237,13 +237,13 @@ classes.
<em>sbpy.activity.gas</em>
</td>
<td align='center'>
<span class="dev"></span>
<span class="stable"></span>
</td>
<td align='center'>
MSK / MdVB
</td>
<td>
Haser model implemented; Vectorial model partially tested;
Haser and Vectorial models implemented
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion sbpy/data/obs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://ssd.jpl.nasa.gov/horizons.cgi>`_
`JPL Horizons system <https://ssd.jpl.nasa.gov/horizons/>`_
(using `~sbpy.data.Ephem.from_horizons`),
the `Minor Planet Center ephemeris service
<https://minorplanetcenter.net/iau/MPEph/MPEph.html>`_
Expand Down
4 changes: 2 additions & 2 deletions sbpy/data/orbit.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://ssd.jpl.nasa.gov/horizons.cgi>`_ using
`JPL Horizons <https://ssd.jpl.nasa.gov/horizons/>`_ using
`astroquery.jplhorizons.HorizonsClass.elements`
Parameters
Expand Down Expand Up @@ -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 <https://ssd.jpl.nasa.gov/?horizons_doc>`_.
`JPL Horizons documentation <https://ssd.jpl.nasa.gov/horizons/manual.html>`_.
* 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
Expand Down
1 change: 1 addition & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 39b0c3c

Please sign in to comment.