Merge pull request #3 from simontorres/improve_docs

Improve docs
soar-telescope · Jul 15, 2019 · a519b77 · a519b77
2 parents 9b3ce13 + 02fb27b
commit a519b77
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,8 @@
-# goodman-lamps-lib
-Library of reference lamps for supported modes.
+# Goodman HTS Reference Lamps Library
+
+[![Documentation Status](https://readthedocs.org/projects/goodman-lamps/badge/?version=latest)](https://goodman-lamps.readthedocs.io/en/latest/?badge=latest)
+
+
+Visual library of reference lamps for supported modes.
+
+See full documentation at [goodman-lamps.readthedocs.io](https://goodman-lamps.readthedocs.io)
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,54 @@
 Welcome to Reference Lamps Library's documentation!
 ===================================================
 
+.. image:: https://readthedocs.org/projects/goodman-lamps/badge/?version=latest
+    :target: https://goodman-lamps.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+This is a visual library of all the usable lamps of the Goodman High Throughput
+Spectrograph.
+
+.. note::
+
+   The plots in this library are automatically generated therefore in some cases
+   if two lines are too close together the labels will appear stacked
+
+
+The table below is presented as a quick reference. It is not generated automatically.
+
+To see a full set of plots of all lamps please visit this `GitHub Repository <https://github.com/simontorres/general_documentation/tree/master/jupyter-notebooks/pipeline_development/lamp-usability>`_
+
+.. table:: Lamp usability per spectroscopic mode
+
+   ========== ========== ========== ========== ========== ========== ========== ==========
+      Mode      Filter       Ne        HgAr      HgArNe     CuHeAr     FeHeAr       Ar
+   ========== ========== ========== ========== ========== ========== ========== ==========
+    400 M1        --         No         Yes        Yes        No         No          No
+    400 M2      GG-450       Yes        Yes        Yes        Yes        Yes         Yes
+    600 UV        --         No         Yes        Yes        Yes        No          No
+    600 Blue      --         No         Yes        Yes        Yes        No          No
+    600 Mid     GG-385       No         Yes        Yes        Yes        No          No
+    600 Red     GG-495       Yes        Yes        Yes        Yes        Yes         Yes
+    930 M1        --         No         Yes        Yes        No         No          No
+    930 M2        --         No         Yes        Yes        Yes        Yes         Yes
+    930 M3      GG-385       No         No         No         Yes        Yes         No
+    930 M4      GG-495       Yes        Yes        Yes        Yes        No          No
+    930 M5      GG-495       Yes        Yes        Yes        Yes        Yes         Yes
+    930 M6      OG-570       Yes        Yes        Yes        Yes        Yes         Yes
+    1200 M0       --         No         No         No         No         No          No
+    1200 M1       --         No         No         No         Yes        Yes         Yes
+    1200 M2       --         No         No         No         Yes        Yes         No
+    1200 M3       --         No         No         No         Yes        Yes         No
+    1200 M4     GG-455       Yes        No         Yes        Yes        Yes         No
+    1200 M5     GG-455       Yes        Yes        Yes        Yes        Yes         Yes
+    1200 M6     GG-495       Yes        Yes        Yes        Yes        Yes         Yes
+    1200 M7     OG-570       Yes        Yes        Yes        Yes        Yes         Yes
+   ========== ========== ========== ========== ========== ========== ========== ==========
+
+
+
+
+
 .. toctree::
    :maxdepth: 2
    :caption: Plots
@@ -21,6 +69,7 @@ Welcome to Reference Lamps Library's documentation!
    :caption: About
 
    license
+   issues
 
 
 Indices and tables

diff --git a/docs/issues.rst b/docs/issues.rst
@@ -0,0 +1,5 @@
+Issues
+======
+
+If you found an error or have a suggestion please
+`Open an Issue <https://github.com/soar-telescope/goodman_lamps/issues>`_
diff --git a/goodman_lamps/goodman_lamps.py b/goodman_lamps/goodman_lamps.py
@@ -95,7 +95,7 @@ def create_plot(mode):
         print(_file)
 
     for file_name in file_list:
-        fig, ax = plt.subplots(figsize=(16, 7))
+        fig, ax = plt.subplots(figsize=(20, 7))
 
         ccd = CCDData.read(file_name, unit='adu')
         line_list = LineList()