Update for P103. Added support for ESPRESSO. Minor bugfix/tweaks.

fpavogt · Oct 14, 2018 · 6f7a983 · 6f7a983
1 parent 3487189
commit 6f7a983
Show file tree

Hide file tree

Showing 22 changed files with 819 additions and 75 deletions.
diff --git a/docs/source/acknowledge.rst b/docs/source/acknowledge.rst
@@ -20,15 +20,15 @@ Acknowledging fcmaker
    reach the publication stage!), please cite:
 
     Vogt, *fcmaker: automating the creation of ESO-compliant finding charts for Observing 
-    Blocks on p2*, Astronomy & Computing, 2018, submitted. `ADS entry <http://adsabs.harvard.edu/abs/2018arXiv180702114V>`_
+    Blocks on p2*, Astronomy & Computing, 2018, 25, 81. `ADS entry <http://adsabs.harvard.edu/abs/2018A%26C....25...81V>`_
 
    In fact, a friendly nudge along the following blurb will give due credits to all those
    that made fcmaker possible in the first place::
    
     This research has made use of \textsc{fcmaker} (Vogt, 2018a,b), a \textsc{python} module 
     to create ESO-compliant finding charts for OBs on \textit{p2}. \textsc{fcmaker} relies 
     on \textsc{matplotlib} (Hunter 2007), \textsc{astropy}, a community-developed core 
-    \textsc{python} package for Astronomy (Astropy Collaboration et al., 2013), 
+    \textsc{python} package for Astronomy (Astropy Collaboration et al., 2013, 2018), 
     \textsc{astroquery}, a package hosted at \url{https://astroquery.readthedocs.io} which 
     provides a set of tools for querying astronomical web forms and databases (Ginsburg et 
     al. 2017), \textsc{astroplan} (Morris et al. 2018), \textsc{aplpy}, an open-source 
@@ -64,13 +64,14 @@ Acknowledging fcmaker
    
     
 - `Astropy Collaboration et al. (2013) <http://cdsads.u-strasbg.fr/abs/2013A%26A...558A..33A>`_ 
+- `Astropy Collaboration et al. (2018) <http://adsabs.harvard.edu/abs/2018arXiv180102634T>`_
 - `Gaia Collaboration et al. (2016) <http://adsabs.harvard.edu/abs/2016A%26A...595A...1G>`_
 - `Ginsburg et al. (2017) <http://adsabs.harvard.edu/abs/2017ascl.soft08004G>`_
 - `Gaia Collaboration et al. (2018) <http://adsabs.harvard.edu/abs/2018arXiv180409365G>`_ 
 - `Hunter (2007) <http://cdsads.u-strasbg.fr/abs/2007CSE.....9...90H>`_  
 - `Morris et al. (2018) <http://adsabs.harvard.edu/abs/2018AJ....155..128M>`_
 - `Ochsenbein (2000) <http://cdsads.u-strasbg.fr/abs/2000A%26AS..143...23O>`_  
 - `Robitaille (2012) <http://adsabs.harvard.edu/abs/2012ascl.soft08017R>`_
-- `Vogt (2018a) <http://adsabs.harvard.edu/abs/2018arXiv180702114V>`_
-- `Vogt (2018b) < >`_
+- `Vogt (2018a) <http://adsabs.harvard.edu/abs/2018A%26C....25...81V>`_
+- `Vogt (2018b) <http://adsabs.harvard.edu/abs/2018ascl.soft06027V>`_
 
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -10,7 +10,10 @@ Changelog |last-commit| |issues|
 ================================
 
 .. todo:: 
+   - check l. 149 in fcmaker_instrument_dispatch ...
+   - (!) for XSHOOTER, always place the slit horizontal (i.e. do not put the chart North)
    - (!) formally validate the parallactic function
+   - (?) check connection to the online servers ahead of time, and issue a nice error if needed 
    - (?) include an instrument-free mode
    - (?) add metadata to .jpg 
    - (?) add support for jitter in HAWKI (showing the max jitter area with a circle) 
@@ -19,6 +22,17 @@ Changelog |last-commit| |issues|
    - (?) make the obsdate an ``fc_params`` entry rather than a global variable
    - (?) for time critical OBs, get the time from the OB
 
+v103.0.0 October 2018, F.P.A. Vogt
+   - changed versioning scheme to highlight the supported Period.
+   - renamed 'O' and 'S' to 'Obj.' and 'Sky' in the legend, for clarity.
+   - for XSHOOTER, show the footprint of the Acq. camera also at the "Target" position.
+   - suppressed all VOTableSpecWarning (they're not my fault!)
+   - added support for ESPRESSO
+   - set astropy logging level to "WARNING" to clean up the prompt
+   - fixed the scalebar fontsize warning from aplpy
+   - added new blind-offset example for XSHOOTER in the doc
+   - fixed tiny bug in calculation of right-plot radius for XSHOOTER and MUSE, in case of blind offsets
+
 v0.4.0 August 2018, F.P.A. Vogt
    - deal with multiple spaces in the local files, e.g. [O  S O]
    - added test OBs on p2demo, reachable via "--demo" mode in fcmaker

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,7 +21,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('../..'))
 
-#print(sys.path)
+# print(sys.path)
 import fcmaker
 
 # -- General configuration ------------------------------------------------

diff --git a/docs/source/examples/gallery.rst b/docs/source/examples/gallery.rst
@@ -176,9 +176,10 @@ To recreate this example finding chart, download
 XSHOOTER
 --------
 The XSHOOTER finding charts show the field-of-view of the acquisition camera in bold purple.
-Slit, IFU or acquisition camera field-of-views are then shown for each offset position, 
-according to the selected observing templates. The minimum valid radius for telescope 
-Guide Stars is 120 arcsec from any offset position. fcmaker will draw the XSHOOTER slit/IFU 
+In case of blind offsets, the field-of-view of the acquisition camera is also shown for the 
+Target position, in orange. Slit, IFU or acquisition camera field-of-views are then shown 
+for each offset position, according to the selected observing templates. The minimum valid 
+radius for telescope Guide Stars is 120 arcsec from any offset position. fcmaker will draw the XSHOOTER slit/IFU 
 at the parallactic angle (if set as such in the OB) **at the time specified by** ``obsdate``
 , only if requested with the ``--do-parang`` flag. Any finding chart associated with 
 parallactic angles is tagged with the symbol :math:`\measuredangle`. The "Target" location 
@@ -188,16 +189,57 @@ finding chart will show the actual target, and **not** the blind-offset star. Fi
 for slit observations, the requested position angle (p.a.) is clearly indicated in the top
 right corner of the left-hand-side plot.
 
+.. figure:: ./fcm_plots/XSHOOTER_OB_BO_DSS2-Red.png
+    :width: 750px
+    :align: center
+    :alt: XSHOOTER BO
+
 .. figure:: ./fcm_plots/XSHOOTER_OB_EPHEM_DSS2-Red.png
     :width: 750px
     :align: center
     :alt: XSHOOTER EPHEM
 
 To recreate this example finding chart, download 
+:download:`local_2_fcm.xshooter_bo.txt <./local_2_fcm.xshooter_bo.txt>` or
 :download:`local_2_fcm.xshooter_ephem.txt <./local_2_fcm.xshooter_ephem.txt>` and run::
 
+   python -m fcmaker -l -f local_2_fcm.xshooter_bo.txt --do-png --systemtex
    python -m fcmaker -l -f local_2_fcm.xshooter_ephem.txt --do-png --systemtex --obsdate 2018-05-15 08:23:00 UTC
 
+
+ESPRESSO
+--------
+The ESPRESSO finding charts show the field-of-view of the acquisition camera in 
+bold purple (17 arcsec in radius). In case of blind offsets, the field-of-view of the 
+acquisition camera is also shown for the Target position, with a dashed orange. The fiber 
+is shown at the Target location, with a size of 1 arcsec (HR, MR modes) or 0.5 arcsec (UHR) 
+in diameter.
+
+For Science templates requiring the fibre B to be on SKY, a dotted circle shows the possible
+locations of Fibre B (7.5 arcsec away from fiber A; the exact location is time dependent).
+The minimum valid radius for telescope guide stars is 120 arcsec from the target and the 
+acquisition position.
+
+.. figure:: ./fcm_plots/ESPRESSO_HR_Gaia.png
+    :width: 750px
+    :align: center
+    :alt: ESPRESSO HR
+
+.. figure:: ./fcm_plots/ESPRESSO_UHR_Gaia.png
+    :width: 750px
+    :align: center
+    :alt: ESPRESSO UHR
+
+
+To recreate these example finding charts, download 
+:download:`local_2_fcm.espresso_HR.txt <./local_2_fcm.espresso_HR.txt>` or 
+:download:`local_2_fcm.espresso_UHR.txt <./local_2_fcm.espresso_UHR.txt>` and run::
+
+   python -m fcmaker -l -f local_2_fcm.espresso_HR.txt --do-png --systemtex
+   python -m fcmaker -l -f local_2_fcm.espresso_UHR.txt --do-png --systemtex
+
+
+
 The fcmaker tags
 ----------------
 

diff --git a/docs/source/examples/local_2_fcm.espresso.txt b/docs/source/examples/local_2_fcm.espresso.txt
@@ -0,0 +1,36 @@
+#
+# A list of basic OB parameters to generate an ESPRESSO finding chart from scratch
+#
+##### OB Info #####
+ob_name:   ESPRESSO_OB     # OB name, required to name the output files!
+ob_id:                     # optional
+pi:                        # optional
+prog_id:                   # optional
+inst:      ESPRESSO        # optional
+ins_mode:  HR              # HR, UHR, MR
+
+##### Target #####
+equinox:   J2000           #
+epoch:     2000.0          #
+ra:        01h44m04.090s   #
+dec:       -15d56m14.900s  #
+pmra:      -1.73           # proper motion in arcsec/year
+pmdec:     0.855           # proper motion in arcsec/year
+ephemeris:                 # relative path+filename of an ephemeris file, optional
+
+###### Acquisition #####
+bos_ra:    0               # Blind-offset (RA), ESPRESSO convention!
+bos_dec:   0               # Blind offset (Dec), ESPRESSO convention!
+is_gs:     False           # User-defined Guide Star ?
+gs_ra:     21h49m22.147s   #
+gs_dec:    +00d27m53.336s  #
+
+###### Observation #####
+calsource_B:      SKY      # if SKY, draw the possible location of fiber B.
+
+##### Other params #####
+bk_image:  Gaia            # None, bk_images to download from SkyView, Gaia, or local fits file
+bk_lam:    None            # None, or else overrides SkyView default.
+data_loc:  fcm_data        # Relative path to the background images (local FITS file or SkyView images)
+plot_loc:  fcm_plots       # Relative path to store the finding charts 
+
diff --git a/docs/source/examples/local_2_fcm.espresso_HR.txt b/docs/source/examples/local_2_fcm.espresso_HR.txt
@@ -0,0 +1,36 @@
+#
+# A list of basic OB parameters to generate an ESPRESSO finding chart from scratch
+#
+##### OB Info #####
+ob_name:   ESPRESSO_HR     # OB name, required to name the output files!
+ob_id: 12345678            # optional
+pi: jdoe                   # optional
+prog_id: 0100.Z-9999       # optional
+inst:      ESPRESSO        # optional
+ins_mode:  HR              # HR, UHR, MR
+
+##### Target #####
+equinox:   J2000           #
+epoch:     2000.0          #
+ra:        01h44m04.090s   #
+dec:       -15d56m14.900s  #
+pmra:      -1.73           # proper motion in arcsec/year
+pmdec:     0.855           # proper motion in arcsec/year
+ephemeris:                 # relative path+filename of an ephemeris file, optional
+
+###### Acquisition #####
+bos_ra:    0               # Blind-offset (RA), ESPRESSO convention!
+bos_dec:   0               # Blind offset (Dec), ESPRESSO convention!
+is_gs:     False           # User-defined Guide Star ?
+gs_ra:     21h49m22.147s   #
+gs_dec:    +00d27m53.336s  #
+
+###### Observation #####
+calsource_B:     DARK      # if SKY, draw the possible location of fiber B.
+
+##### Other params #####
+bk_image:  Gaia            # None, bk_images to download from SkyView, Gaia, or local fits file
+bk_lam:    None            # None, or else overrides SkyView default.
+data_loc:  fcm_data        # Relative path to the background images (local FITS file or SkyView images)
+plot_loc:  fcm_plots       # Relative path to store the finding charts 
+
diff --git a/docs/source/examples/local_2_fcm.espresso_UHR.txt b/docs/source/examples/local_2_fcm.espresso_UHR.txt
@@ -0,0 +1,36 @@
+#
+# A list of basic OB parameters to generate an ESPRESSO finding chart from scratch
+#
+##### OB Info #####
+ob_name:   ESPRESSO_UHR    # OB name, required to name the output files!
+ob_id: 12345678            # optional
+pi: jdoe                   # optional
+prog_id: 0100.Z-9999       # optional
+inst:      ESPRESSO        # optional
+ins_mode:  UHR              # HR, UHR, MR
+
+##### Target #####
+equinox:   J2000           #
+epoch:     2000.0          #
+ra:        13h47m09.953s   #
+dec:       -62d35m15.990s  #
+pmra:      -0.005647       # proper motion in arcsec/year
+pmdec:     -0.002211       # proper motion in arcsec/year
+ephemeris:                 # relative path+filename of an ephemeris file, optional
+
+###### Acquisition #####
+bos_ra:    6.38            # Blind-offset (RA), ESPRESSO convention!
+bos_dec:   -6.85           # Blind offset (Dec), ESPRESSO convention!
+is_gs:     True            # User-defined Guide Star ?
+gs_ra:     13h48m15.751s   #
+gs_dec:    -62d28m29.205s  #
+
+###### Observation #####
+calsource_B:      SKY      # if SKY, draw the possible location of fiber B.
+
+##### Other params #####
+bk_image:  Gaia            # None, bk_images to download from SkyView, Gaia, or local fits file
+bk_lam:    None            # None, or else overrides SkyView default.
+data_loc:  fcm_data        # Relative path to the background images (local FITS file or SkyView images)
+plot_loc:  fcm_plots       # Relative path to store the finding charts 
+
diff --git a/docs/source/examples/local_2_fcm.xshooter_bo.txt b/docs/source/examples/local_2_fcm.xshooter_bo.txt
@@ -0,0 +1,46 @@
+#
+# A list of basic OB parameters to generate an XSHOOTER finding chart from scratch
+#
+##### OB Info #####
+ob_name:   XSHOOTER_OB_BO # OB name, required to name the output files!
+ob_id:     12345678       # optional
+pi:        jdoe           # optional
+prog_id:   0100.Z-9999    # optional
+inst:      XSHOOTER       # Required!
+
+##### Target #####        
+equinox:   J2000          #
+epoch:     2000.0         #
+ra:        13h48m09.180s  # E.g.: 21h49m07.290s
+dec:       -62d28m34.000s # E.g.: +00d26m55.000s
+pmra:      0.0000         # proper motion in arcsec/year
+pmdec:     0.0000         # proper motion in arcsec/year
+ephemeris:                # relative path+filename of an ephemeris file, optional
+
+##### Acquisition #####   
+bos_ra:    46             # Blind-offset (RA), XSHOOTER convention!
+bos_dec:   5              # Blind offset (Dec), XSHOOTER convention!
+acq_pa:    0              # Acquisition Position Angle (degrees), XSHOOTER convention!
+is_gs:     False          # User-defined Guide Star ?
+gs_ra:     21h49m22.147s  #
+gs_dec:    +00d27m53.336s #
+
+##### Observation #####
+ins_mode:  slt            # Can be slt, img or ifu
+uvb_slt:   1.0            #
+vis_slt:   1.0            #
+nir_slt:   1.0            #
+slt_throw: 0.0            # The Nodding Throw along the slit
+noff:      2              #
+obstype:   [O S]          # Offsets must be separated by a single space!
+coordtype: SKY            # DETECTOR = SLIT, or SKY
+off1:      [0 5]          # Offsets must be separated by a single space!
+off2:      [0 -20]        # Offsets must be separated by a single space!
+return:    True           
+
+##### Other params #####
+bk_image:  DSS2 Red       # None, bk_images to download from SkyView, or local fits file
+bk_lam:    None           # None, or else overrides SkyView default
+data_loc:  fcm_data       # Relative path to the background images (local FITS file or SkyView images)
+plot_loc:  fcm_plots      # Relative path to store the finding charts 
+
diff --git a/docs/source/examples/run_examples.sh b/docs/source/examples/run_examples.sh
@@ -0,0 +1,12 @@
+python -m fcmaker -l -f local_2_fcm.muse_wfm-noao.txt --do-png --systemtex --do-pdf
+python -m fcmaker -l -f local_2_fcm.muse_wfm-ao.txt --do-png --systemtex --do-pdf
+python -m fcmaker -l -f local_2_fcm.muse_nfm-Gaia.txt --do-png --systemtex --do-pdf
+python -m fcmaker -l -f local_2_fcm.muse_nfm-DSS.txt --do-png --systemtex --do-pdf
+python -m fcmaker -l -f local_2_fcm.muse_nfm-HST.txt --do-png --systemtex --do-pdf
+python -m fcmaker -l -f local_2_fcm.hawki_noao.txt --do-png --systemtex --do-pdf
+python -m fcmaker -l -f local_2_fcm.hawki_fph.txt --do-png --systemtex --do-pdf
+python -m fcmaker -l -f local_2_fcm.xshooter_ephem.txt --do-png --systemtex --obsdate 2018-05-15 08:23:00 UTC --do-pdf
+python -m fcmaker -l -f local_2_fcm.xshooter_pm.txt --do-png --systemtex --do-pdf
+python -m fcmaker -l -f local_2_fcm.xshooter_bo.txt --do-png --systemtex --do-pdf
+python -m fcmaker -l -f local_2_fcm.espresso_HR.txt --do-png --systemtex --do-pdf
+python -m fcmaker -l -f local_2_fcm.espresso_UHR.txt --do-png --systemtex --do-pdf 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -47,9 +47,10 @@ fcmaker |release| |stars| |watch|
 Instruments and modes currently supported
 -----------------------------------------
 
-   * **MUSE**: WFM NOAO, WFM AO, NFM
-   * **HAWKI**: NOAO, AO (including fast photometry)
+   * **MUSE**: all modes
+   * **HAWKI**: NOAO, TT-free AO, including fast photometry
    * **XSHOOTER**: all modes
+   * **ESPRESSO**: all modes
    * targets with proper motions, ephemeris files
    * tutorial OBs on `p2demo <http://www.eso.org/p2demo>`_
 
@@ -67,6 +68,7 @@ Contents
    faq
    changelog
    acknowledge
+   Github <https://github.com/fpavogt/fcmaker>
 
 
 fcmaker is a Python3 module that offers a rapid, easy and automated way to generate 

diff --git a/docs/source/modules/fcmaker.rst b/docs/source/modules/fcmaker.rst
@@ -12,6 +12,14 @@ fcmaker\.fcmaker module
     :undoc-members:
     :show-inheritance:
 
+fcmaker\.fcmaker\_espresso module
+---------------------------------
+
+.. automodule:: fcmaker.fcmaker_espresso
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 fcmaker\.fcmaker\_hawki module
 ------------------------------
 

diff --git a/docs/source/modules/modules.rst b/docs/source/modules/modules.rst
@@ -1,5 +1,5 @@
-The modules of fcmaker
-======================
+The functions of fcmaker
+========================
 
 .. toctree::
    :maxdepth: 4