Merge branch 'master' into twilight

Author: dkirkby

LICENSE.rst

@@ -9,8 +9,8 @@ are permitted provided that the following conditions are met:
 * Redistributions in binary form must reproduce the above copyright notice, this
   list of conditions and the following disclaimer in the documentation and/or
   other materials provided with the distribution.
-* Neither the name of the Astropy Team nor the names of its contributors may be
-  used to endorse or promote products derived from
+* Neither the name of the DESI Collaboration nor the names of its contributors
+  may be used to endorse or promote products derived from
   this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

doc/changes.rst

@@ -2,10 +2,19 @@
 desisurvey change log
 =====================
 
-0.9.4 (unreleased)
-------------------
+0.10.1 (unreleased)
+-------------------
+
+* Set the ``EXTNAME`` keyword on the Table returned by ``Progress.get_exposures()``.
+
+0.10.0 (2017-11-09)
+-------------------
+
+* Progress.get_exposures() updates:
 
-* No changes yet.
+  * includes FLAVOR and PROGRAM columns.
+  * uses desimodel.footprint.pass2program if available.
+  * standardized on UPPERCASE column names and NIGHT=YEARMMDD not YEAR-MM-DD.
 
 0.9.3 (2017-10-09)
 ------------------

py/desisurvey/_version.py

@@ -1 +1 @@
-__version__ = '0.9.3.dev614'
+__version__ = '0.10.0.dev632'

py/desisurvey/progress.py

@@ -484,8 +484,9 @@ def add_exposure(self, tile_id, start, exptime, snr2frac, airmass, seeing,
 
     def get_exposures(self, start=None, stop=None,
                       tile_fields='tileid,pass,ra,dec,ebmv',
-                      exp_fields='night,mjd,exptime,seeing,transparency,'
-                      +'airmass,moonfrac,moonalt,moonsep'):
+                      exp_fields=('night,mjd,exptime,seeing,transparency,' +
+                                  'airmass,moonfrac,moonalt,moonsep,' +
+                                  'program,flavor')):
         """Create a table listing exposures in time order.
 
         Parameters
@@ -505,7 +506,7 @@ def get_exposures(self, start=None, stop=None,
             Comma-separated list of per-exposure field names to include. The
             special name 'snr2cum' denotes the cummulative snr2frac on each
             tile, since the start of the survey.  The special name 'night'
-            denotes a string YYYY-MM-DD specifying the date on which each
+            denotes a string YYYYMMDD specifying the date on which each
             night starts. The special name 'lst' denotes the apparent local
             sidereal time of the shutter open timestamp. The special name
             'expid' denotes the index of each exposure in the full progress
@@ -514,7 +515,7 @@ def get_exposures(self, start=None, stop=None,
         Returns
         -------
         astropy.table.Table
-            Table with the specified columns and one row per exposure.
+            Table with the specified columns as uppercase and one row per exposure.
         """
         # Get MJD range to show.
         if start is None:
@@ -549,52 +550,75 @@ def get_exposures(self, start=None, stop=None,
         # Create the output table.
         tileinfo = None
         output = astropy.table.Table()
+        output.meta['EXTNAME'] = 'EXPOSURES'
         for name in tile_fields.split(','):
+            name = name.lower()
             if name == 'index':
-                output[name] = tile_index
+                output[name.upper()] = tile_index
             elif name == 'ebmv':
                 if tileinfo is None:
                     config = desisurvey.config.Configuration()
                     tileinfo = astropy.table.Table(
                         desimodel.io.load_tiles(onlydesi=True, extra=False,
                         tilesfile=config.tiles_file()))
                     assert np.all(tileinfo['TILEID'] == table['tileid'])
-                output[name] = tileinfo['EBV_MED'][tile_index]
+                output[name.upper()] = tileinfo['EBV_MED'][tile_index]
             else:
                 if name not in table.colnames or len(table[name].shape) != 1:
                     raise ValueError(
                         'Invalid tile field name: {0}.'.format(name))
-                output[name] = table[name][tile_index]
+                output[name.upper()] = table[name][tile_index]
         for name in exp_fields.split(','):
+            name = name.lower()
             if name == 'snr2cum':
                 snr2cum = np.cumsum(
                     table['snr2frac'], axis=1).flatten()[order]
-                output[name] = astropy.table.Column(
+                output[name.upper()] = astropy.table.Column(
                     snr2cum, format='%.3f',
                     description='Cummulative fraction of target S/N**2')
             elif name == 'night':
                 mjd = table['mjd'].flatten()[order]
-                night = np.empty(len(mjd), dtype='S10')
+                night = np.empty(len(mjd), dtype=(str, 8))
                 for i in range(len(mjd)):
-                    night[i] = str(desisurvey.utils.get_date(mjd[i]))
-                output[name] = astropy.table.Column(
+                    night[i] = str(desisurvey.utils.get_date(mjd[i])).replace('-', '')
+                output[name.upper()] = astropy.table.Column(
                     night,
                     description='Date at start of night when exposure taken')
             elif name == 'lst':
                 mjd = table['mjd'].flatten()[order]
                 times = astropy.time.Time(
                     mjd, format='mjd', location=desisurvey.utils.get_location())
                 lst = times.sidereal_time('apparent').to(u.deg).value
-                output[name] = astropy.table.Column(
+                output[name.upper()] = astropy.table.Column(
                     lst, format='%.1f', unit='deg',
                     description='Apparent local sidereal time in degrees')
+            elif name == 'program':
+                exppass = table['pass'][tile_index]
+                try:
+                    from desimodel.footprint import pass2program
+                    program = pass2program(exppass)
+                except ImportError:
+                    #- desimodel < 0.9.1 doesn't have pass2program, so
+                    #- hardcode the mapping that it did have
+                    program = np.empty(len(exppass), dtype=(str, 6))
+                    program[:] = 'BRIGHT'
+                    program[exppass < 4] = 'DARK'
+                    program[exppass == 4] = 'GRAY'
+
+                output[name.upper()] = astropy.table.Column(program,
+                                                            description='Program name')
+            elif name == 'flavor':
+                flavor = np.empty(len(exppass), dtype=(str, 7))
+                flavor[:] = 'science'
+                output[name.upper()] = astropy.table.Column(flavor,
+                    description='Exposure flavor')
             elif name == 'expid':
-                output[name] = astropy.table.Column(
+                output[name.upper()] = astropy.table.Column(
                     expid[order], description='Exposure index')
             else:
                 if name not in table.colnames or len(table[name].shape) != 2:
                     raise ValueError(
                         'Invalid exposure field name: {0}.'.format(name))
-                output[name] = table[name].flatten()[order]
+                output[name.upper()] = table[name].flatten()[order]
 
         return output

py/desisurvey/test/test_progress.py

@@ -6,6 +6,7 @@
 import numpy as np
 
 import astropy.units as u
+from astropy.table import Table
 
 import desisurvey.config
 
@@ -97,24 +98,36 @@ def test_get_exposures(self):
             p.add_exposure(
                 tile_id, t0 + i * u.hour, 1e3 * u.s, 0.5, 1.5, 1.1, 1, 0, 0, 0)
         explist = p.get_exposures()
-        self.assertTrue(np.all(np.diff(explist['mjd']) > 0))
+        self.assertEqual(explist.meta['EXTNAME'], 'EXPOSURES')
+        self.assertTrue(np.all(np.diff(explist['MJD']) > 0))
         explist = p.get_exposures(tile_fields='index', exp_fields='lst')
-        self.assertTrue(np.all(np.diff(explist['lst']) > 0))
-        self.assertTrue(np.min(explist['lst'] >= 0))
-        self.assertTrue(np.max(explist['lst'] < 360))
+        self.assertTrue(np.all(np.diff(explist['LST']) > 0))
+        self.assertTrue(np.min(explist['LST'] >= 0))
+        self.assertTrue(np.max(explist['LST'] < 360))
         with self.assertRaises(ValueError):
             p.get_exposures(tile_fields='mjd')
         with self.assertRaises(ValueError):
             p.get_exposures(tile_fields='nonexistent')
-        with self.assertRaises(ValueError):
-            p.get_exposures(exp_fields='pass')
-        explist = p.get_exposures(exp_fields='mjd,night')
+        # with self.assertRaises(ValueError):
+        #     p.get_exposures(exp_fields='pass')
+        explist = p.get_exposures(exp_fields='mjd,night,program')
         for row in explist:
-            self.assertEqual(desisurvey.utils.get_date(row['mjd']),
-                             desisurvey.utils.get_date(row['night']))
-            night = str(desisurvey.utils.get_date(row['mjd']))
+            self.assertEqual(desisurvey.utils.get_date(row['MJD']),
+                             desisurvey.utils.get_date(row['NIGHT']))
+            night = str(desisurvey.utils.get_date(row['MJD']))
             self.assertEqual(night, str(desisurvey.utils.get_date(night)))
 
+        #- Test roundtrip to disk
+        expfile = os.path.join(self.tmpdir, 'test-exposures.fits')
+        explist.write(expfile)
+        newexp = Table.read(expfile)
+
+        self.assertEqual(newexp.meta['EXTNAME'], 'EXPOSURES')
+        self.assertEqual(explist['PROGRAM'].dtype, newexp['PROGRAM'].dtype)
+        self.assertEqual(explist['NIGHT'].dtype, newexp['NIGHT'].dtype)
+        self.assertTrue(np.all(explist['PROGRAM'] == newexp['PROGRAM']))
+        self.assertTrue(np.all(explist['NIGHT'] == newexp['NIGHT']))
+
     def test_exposures_incrementing(self):
         """Successive exposures of the same tile must be time ordered"""
         p = Progress()

py/desisurvey/utils.py

@@ -508,7 +508,13 @@ def get_date(date):
         # Convert a string of the form YYYY-MM-DD into a date.
         # This will raise a ValueError for a badly formatted string
         # or invalid date such as 2019-13-01.
-        date = datetime.datetime.strptime(date, '%Y-%m-%d').date()
+        try:
+            date = datetime.datetime.strptime(date, '%Y-%m-%d').date()
+        except ValueError:
+            try:
+                date = datetime.datetime.strptime(date, '%Y%m%d').date()
+            except ValueError:
+                raise
     except TypeError:
         pass
     # valid types: number, Time, datetime, date