Skip to content

Commit

Permalink
Fixed issues #3
Browse files Browse the repository at this point in the history
  • Loading branch information
fpavogt committed Jul 9, 2018
1 parent cfb0ee2 commit 47ce9b2
Show file tree
Hide file tree
Showing 9 changed files with 87 additions and 44 deletions.
60 changes: 40 additions & 20 deletions docs/source/acknowledge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,62 @@
.. |DOI_latest| image:: https://zenodo.org/badge/119476467.svg
:target: https://zenodo.org/badge/latestdoi/119476467

.. |ascl| image:: https://img.shields.io/badge/ascl-1806.027-blue.svg?colorB=262255
:target: http://ascl.net/1806.027

Acknowledging fcmaker
=====================

1) Only use lower case letters when mentioning fcmaker, and always include the version number.
Ideally, you should also include the DOI (Digital Object Identifier) associated with any
of the Github releases, e.g.:

fcmaker |version|: |DOI_latest|
Ideally, you should also include a) the DOI associated with any of the Github releases,
and b) the code's `ASCL entry number <https://ascl.net/1806.027>`_, e.g.:

fcmaker |version|: |DOI_latest| |ascl|

-----

2) If you use fcmaker for your observations (and remember that you did so by the time you
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.
Blocks on p2*, Astronomy & Computing, 2018, submitted. `ADS entry <http://adsabs.harvard.edu/abs/2018arXiv180702114V>`_

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, 2018), a \textsc{python} module
This research has made use of \textsc{fcmaker} (Vogt, 2018a,b), a \textsc{python} module
to create ESO-compliant finding charts. \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{astroplan} (Morris et al.
2018), \textsc{aplpy}, an open-source plotting package for \textsc{python} (Robitaille 2012),
and \textsc{montage}, funded by the National Science Foundation under Grant Number
ACI-1440620 and previously funded by the National Aeronautics and Space
Administration’s Earth Science Technology Office, Computation Technologies Project,
under Cooperative Agreement Number NCC5-626 between NASA and the California Institute
of Technology. \textsc{fcmaker} uses the VizieR catalogue access tool, CDS, Strasbourg,
France. The original description of the VizieR service was published in Ochsenbein (2000).
\textsc{fcmaker} also makes use of data from the European Space Agency (ESA) mission
2018), \textsc{aplpy}, an open-source plotting package for \textsc{python} (Robitaille
2012), and \textsc{montage}, funded by the National Science Foundation under Grant Number
ACI-1440620 and previously funded by the National Aeronautics and Space Administration’s
Earth Science Technology Office, Computation Technologies Project, under Cooperative
Agreement Number NCC5-626 between NASA and the California Institute of Technology.
\textsc{fcmaker} uses the VizieR catalogue access tool, CDS, Strasbourg, France. The
original description of the VizieR service was published in Ochsenbein (2000).
\textsc{fcmaker} makes use of data from the European Space Agency (ESA) mission
Gaia (\url{https://www.cosmos.esa.int/gaia}), processed by the Gaia Data Processing
and Analysis Consortium (DPAC,
\url{https://www.cosmos.esa.int/web/gaia/dpac/consortium}). Funding for the DPAC has been
provided by national institutions, in particular the institutions participating in the
Gaia Multilateral Agreement. In particular, \textsc{fcmaker} uses data from the Gaia
(Gaia Collaboration et al., 2016) Data Release 2 (Gaia Collaboration et al., 2018).
and Analysis Consortium (DPAC, \url{https://www.cosmos.esa.int/web/gaia/dpac/consortium}).
Funding for the DPAC has been provided by national institutions, in particular the
institutions participating in the Gaia Multilateral Agreement. In particular,
\textsc{fcmaker} uses data from the Gaia (Gaia Collaboration et al., 2016) Data Release
2 (Gaia Collaboration et al., 2018). \textsc{fcmaker} also uses data from the Second
Digitized Sky Survey (DSS 2). The ``Second Epoch Survey'' of the southern sky was produced
by the Anglo-Australian Observatory (AAO) using the UK Schmidt Telescope. Plates from
this survey have been digitized and compressed by the STScI. The digitized images are
copyright (c) 1993-1995 by the Anglo-Australian Telescope Board. The ``Equatorial Red
Atlas'' of the southern sky was produced using the UK Schmidt Telescope. Plates from
this survey have been digitized and compressedby the STScI. The digitized images are
copyright (c) 1992-1995, jointly bythe UK SERC/PPARC (Particle Physics and Astronomy
Research Council, formerly Science and Engineering Research Council) and the
Anglo-Australian Telescope Board. The compressed files of the ``Palomar Observatory -
Space Telescope Science Institute Digital Sky Survey'' of the northern sky, based on
scans of the Second Palomar Sky Survey, are copyright (c) 1993-1995 by the California
Institute of Technology. All DSS2 material not subject to one of the above copyright
provisions is copyright(c) 1995 by the Association of Universities for Research in
Astronomy, Inc., produced under Contract No. NAS 5-26555 with the National Aeronautics
and Space Administration.

Expand All @@ -50,4 +68,6 @@ Acknowledging fcmaker
- `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 (2018) < >`_
- `Vogt (2018a) <http://adsabs.harvard.edu/abs/2018arXiv180702114V>`_
- `Vogt (2018b) < >`_

12 changes: 10 additions & 2 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@
.. |last-commit| image:: https://img.shields.io/github/last-commit/fpavogt/fcmaker.svg?colorB=e6c000
:target: https://github.com/fpavogt/fcmaker

Changelog |last-commit|
=======================
.. |issues| image:: https://img.shields.io/github/issues/fpavogt/fcmaker.svg?colorB=b4001e
:target: https://github.com/fpavogt/fcmaker/issues

Changelog |last-commit| |issues|
================================

.. todo::
- (!) figure out a way to add est OBs of test-p2 ?
- (?) include an instrument-free mode
- (?) add metadata to .jpg
- (!) formally validate the parallactic function
Expand All @@ -16,6 +20,10 @@ Changelog |last-commit|
- (?) make the obsdate an ``fc_params`` entry rather than a global variable
- (?) for time critical OBs, get the time from the OB

v0.3.6 July 2018, Fp.P.A. Vogt
- fixed a `bad bug <https://github.com/fpavogt/fcmaker/issues/3>`_ for HAWKI and XSHOOTER OBs on p2
- for MUSE OBs on local mode, tries to display the TTS only if WFM-AO, or NFM.

v0.3.5 June 2018, F.P.A. Vogt
- fixed bad bug when feeding no ``obid``

Expand Down
35 changes: 21 additions & 14 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,39 @@
.. |DOI_latest| image:: https://zenodo.org/badge/119476467.svg
:target: https://zenodo.org/badge/latestdoi/119476467

.. |ascl| image:: https://img.shields.io/badge/ascl-1806.027-blue.svg?colorB=262255
:target: http://ascl.net/1806.027

fcmaker |release| |stars| |watch|
===============================================
.. |pypi| image:: https://img.shields.io/pypi/v/fcmaker.svg?colorB=<brightgreen>
:target: https://pypi.python.org/pypi/fcmaker/

.. |last-commit| image:: https://img.shields.io/github/last-commit/fpavogt/fcmaker.svg?colorB=e6c000
:target: https://github.com/fpavogt/fcmaker

|DOI_latest| |pypi| |last-commit| |issues| |astropy|
.. |issues| image:: https://img.shields.io/github/issues/fpavogt/fcmaker.svg?colorB=b4001e
:target: https://github.com/fpavogt/fcmaker/issues

.. |astropy| image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
:target: http://www.astropy.org/

.. |pypi| image:: https://img.shields.io/pypi/v/fcmaker.svg?colorB=<brightgreen>
:target: https://pypi.python.org/pypi/fcmaker/

.. |github| image:: https://img.shields.io/github/release/fpavogt/fcmaker.svg
:target: https://github.com/fpavogt/fcmaker/releases


.. |stars| image:: https://img.shields.io/github/stars/fpavogt/fcmaker.svg?style=social&label=Stars
:target: https://github.com/fpavogt/fcmaker/

.. |watch| image:: https://img.shields.io/github/watchers/fpavogt/fcmaker.svg?style=social&label=Watch
:target: https://github.com/fpavogt/fcmaker/


.. |github| image:: https://img.shields.io/github/release/fpavogt/fcmaker.svg
:target: https://github.com/fpavogt/fcmaker/releases

.. |issues| image:: https://img.shields.io/github/issues/fpavogt/fcmaker.svg?colorB=b4001e
:target: https://github.com/fpavogt/fcmaker/issues

.. |last-commit| image:: https://img.shields.io/github/last-commit/fpavogt/fcmaker.svg?colorB=e6c000
:target: https://github.com/fpavogt/fcmaker
fcmaker |release| |stars| |watch|
=================================

|pypi| |DOI_latest| |ascl| |astropy| |last-commit|


.. figure:: ./examples/fcm_plots/MUSE_WFM_AO_DSS2-Red.png
:width: 750px
Expand Down Expand Up @@ -71,7 +78,7 @@ night time operations. They aim at providing a clear and accurate view of the ex
execution of an OB, given its parameters **(i.e. without any further manual input)**. Note
that unlike `p2 <http://www.eso.org/p2>`_, fcmaker does **not** perform any validation
checks on the OB: it merely prints what they do, be it valid or not. **In essence, fcmaker
is intended to provide the user with the ability to visually check the content of an OB.**
provides the user with the ability to visually check the content of an OB.**

I expect/hope that fcmaker, despite being fully automated, will do a reasonable job for
most OBs of the supported instruments and modes. Should you stumble upon a case where
Expand Down
2 changes: 1 addition & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@ In a terminal shell, try to access the basic help of fcmaker::
python -m fcmaker --help
If that works, chances are, you will probably be fine. Note that fcmaker requires a
connection to the internet to work (even in local mode!).
connection to the internet to work (even in local mode).


10 changes: 8 additions & 2 deletions fcmaker/fcmaker_hawki.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,12 @@ def detector_to_sky(dx,dy,pa):
return (dra, ddec)

# ----------------------------------------------------------------------------------------
def get_p2fcdata_hawki(ob, api):
def get_p2fcdata_hawki(fc_params, ob, api):
'''
Extracts all the important info to build a finding chart from a given HAWKI OB from p2.
Args:
fc_params: dictionnary of finding chart parameters
ob: an api.getOB() object
api: a p2api.ApiConnection() object
Returns:
Expand Down Expand Up @@ -577,7 +578,12 @@ def plot_field(ax1, ax2, fc_params, field):
delta_ra = xys[j][0]*u.arcsec,
delta_dec = xys[j][1]*u.arcsec)

ax.add_label(label_coord.ra.deg,label_coord.dec.deg,r'\textbf{Q%i}' % (j+1),
if fcm_m.fcm_usetex:
lab = r'\textbf{Q%i}' % (j+1)
else:
lab = r'Q%i' % (j+1)

ax.add_label(label_coord.ra.deg,label_coord.dec.deg,lab,
verticalalignment='center',
horizontalalignment='center',size=12,color=skins[field[4]]['c'],
bbox=dict(facecolor='w',ec='none', alpha=0.6), zorder=2
Expand Down
2 changes: 1 addition & 1 deletion fcmaker/fcmaker_metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
'''

# Define the version of fcmaker
__version__ = '0.3.5'
__version__ = '0.3.6'

# Where are we located ?
fcm_dir = os.path.dirname(__file__)
Expand Down
7 changes: 4 additions & 3 deletions fcmaker/fcmaker_muse.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ def left_radius(ins_mode):
inner_GS_search = 120. # inner limit to find Guide Stars

# TTS validity area
inner_TTS_search = 1.725/2.*60 # in arcsec
outer_TTS_search = 3.590/2.*60 # in arcsec
inner_TTS_search = 1.725/2.*60 # in degree
outer_TTS_search = 3.590/2.*60 # in degree
outer_OATT_search = 3.35 # in arcsec, radius of the on-axis TT star (NFM

# List the supported MUSE observing templates
Expand Down Expand Up @@ -155,6 +155,7 @@ def get_p2fcdata_muse(fc_params, ob, api):
Extracts all the important info to build a finding chart from a given MUSE OB from p2.
Args:
fc_params: dictionnary of finding chart parameters
ob: an api.getOB() object
api: a p2api.ApiConnection() object
Returns:
Expand Down Expand Up @@ -662,7 +663,7 @@ def plot_field(ax1, ax2, fc_params, field):


# Show the WFM-AO TT stars
if fc_params['acq']['is_tts']:
if fc_params['acq']['is_tts'] and ('WFM-AO' in fc_params['ins_mode']):
for (t,tts) in enumerate([fc_params['acq']['tts1'],fc_params['acq']['tts2']]):

# Skip if it is not defined (0,0 is the default)
Expand Down
1 change: 1 addition & 0 deletions fcmaker/fcmaker_xshooter.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ def get_p2fcdata_xshooter(fc_params, ob, api):
Extracts all the important info to build a finding chart from a given XSHOOTER OB from p2.
Args:
fc_params: dictionnary of finding chart parameters
ob: an api.getOB() object
api: a p2api.ApiConnection() object
Returns:
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name='fcmaker',
version='0.3.5',
version='0.3.6',
author='F.P.A. Vogt',
author_email='[email protected]',
packages=['fcmaker',],
Expand Down

0 comments on commit 47ce9b2

Please sign in to comment.