Skip to content

Commit

Permalink
Merge f92b33b into 3cb282b
Browse files Browse the repository at this point in the history
  • Loading branch information
weaverba137 committed May 8, 2024
2 parents 3cb282b + f92b33b commit d29d690
Show file tree
Hide file tree
Showing 5 changed files with 72 additions and 23 deletions.
26 changes: 13 additions & 13 deletions .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ jobs:
fail-fast: true
matrix:
os: [ubuntu-latest]
python-version: ['3.9', '3.10'] #, '3.11'] There are still issues with Numpy <1.23 and 3.11.
numpy-version: ['<1.23']
python-version: ['3.10'] # There are still issues with Numpy <1.23 and 3.11.
numpy-version: ['<1.23', '<1.24', '<2.0']
astropy-version: ['<5.1', '<6.0', '<7.0']

steps:
- name: Checkout code
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Python dependencies
Expand All @@ -47,15 +47,15 @@ jobs:
matrix:
os: [ubuntu-latest]
python-version: ['3.10']
astropy-version: ['<5.1']
# astropy-version: ['<5.1'] not used at this time.

steps:
- name: Checkout code
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Python dependencies
Expand All @@ -81,11 +81,11 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Python dependencies
Expand All @@ -104,11 +104,11 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Python dependencies
Expand All @@ -131,11 +131,11 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Python dependencies
Expand Down
4 changes: 3 additions & 1 deletion doc/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ Change Log
3.4.3 (unreleased)
------------------

* No changes yet.
* Check input bounds in :func:`~desiutil.names.radec_to_desiname` (PR `#207`_).

.. _`#207`: https://github.com/desihub/desiutil/pull/207

3.4.2 (2023-11-29)
------------------
Expand Down
25 changes: 20 additions & 5 deletions py/desiutil/names.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,45 @@
def radec_to_desiname(target_ra, target_dec):
"""Convert the right ascension and declination of a DESI target
into the corresponding "DESINAME" for reference in publications.
Length of target_ra and target_dec must be the same if providing an
Length of `target_ra` and `target_dec` must be the same if providing an
array or list. Note that these names are not unique for roughly
one percent of DESI targets, so also including TARGETID in
publications is highly recommended for uniqueness.
Parameters
----------
target_ra: array of :class:`float64`
target_ra: array of :class:`~numpy.float64`
Right ascension in degrees of target object(s). Can be float, double,
or array/list of floats or doubles
target_dec: array of :class:`float64`
or array/list of floats or doubles.
target_dec: array of :class:`~numpy.float64`
Declination in degrees of target object(s). Can be float, double,
or array/list of floats or doubles
or array/list of floats or doubles.
Returns
-------
array of :class:`str`
The DESI names referring to the input target RA and DEC's. Array is
the same length as the input arrays.
Raises
------
ValueError
If any input values are out of bounds.
"""
# Convert to numpy array in case inputs are scalars or lists
target_ra, target_dec = np.atleast_1d(target_ra), np.atleast_1d(target_dec)

base_tests = [('NaN values', np.isnan),
('Infinite values', np.isinf),]
inputs = {'target_ra': {'data': target_ra,
'tests': base_tests + [('RA not in range [0, 360)', lambda x: (x < 0) | (x >= 360))]},
'target_dec': {'data': target_dec,
'tests': base_tests + [('Dec not in range [-90, 90]', lambda x: (x < -90) | (x > 90))]}}
for i in inputs:
for message, check in inputs[i]['tests']:
if check(inputs[i]['data']).any():
raise ValueError(f"{message} detected in {i}!")

# Number of decimal places in final naming convention
precision = 4

Expand Down
36 changes: 34 additions & 2 deletions py/desiutil/test/test_names.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"""
import unittest
import numpy as np
from ..names import radec_to_desiname


class TestNames(unittest.TestCase):
Expand All @@ -19,9 +20,8 @@ def tearDownClass(cls):
pass

def test_radec_to_desiname(self):
"""Test MaskedArrayWithLimits
"""Test computation of desiname.
"""
from ..names import radec_to_desiname
ras = [6.2457354547234, 23.914121939862518, 36.23454570972834,
235.25235223446, 99.9999999999999]
decs = [29.974787585945496, -42.945872347904356, -0.9968423456,
Expand All @@ -44,3 +44,35 @@ def test_radec_to_desiname(self):
outnames = radec_to_desiname(np.array(ras),
np.array(decs))
self.assertTrue(np.alltrue(outnames == correct_names))

def test_radec_to_desiname_bad_values(self):
"""Test exceptions when running radec_to_desiname with bad values.
"""
ras = [6.2457354547234, 23.914121939862518, 36.23454570972834,
235.25235223446, 99.9999999999999]
decs = [29.974787585945496, -42.945872347904356, -0.9968423456,
8.45677345352345, 89.234958294953]

original_ra = ras[2]
for message, value in [("NaN values detected in target_ra!", np.nan),
("Infinite values detected in target_ra!", np.inf),
("RA not in range [0, 360) detected in target_ra!", -23.914121939862518),
("RA not in range [0, 360) detected in target_ra!", 360.23454570972834)]:
ras[2] = value
with self.assertRaises(ValueError) as e:
outnames = radec_to_desiname(ras, decs)
self.assertEqual(str(e.exception), message)

ras[2] = original_ra

original_dec = decs[2]
for message, value in [("NaN values detected in target_dec!", np.nan),
("Infinite values detected in target_dec!", np.inf),
("Dec not in range [-90, 90] detected in target_dec!", -90.9968423456),
("Dec not in range [-90, 90] detected in target_dec!", 90.9968423456)]:
decs[2] = value
with self.assertRaises(ValueError) as e:
outnames = radec_to_desiname(ras, decs)
self.assertEqual(str(e.exception), message)

decs[2] = original_dec
4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ package_dir =
=py
packages = find:
include_package_data = True
python_requires = >=3.8
python_requires = >=3.9
# setup_requires = setuptools_scm
install_requires =
requests
pyyaml
numpy<1.23
numpy<2.0
astropy>=5.0
healpy
matplotlib
Expand Down

0 comments on commit d29d690

Please sign in to comment.