Merge pull request #167 from GreenBankObservatory/update-docs

Update docs and add test files

docs/source/examples/positionswitch.rst

@@ -146,6 +146,9 @@ You can also print a concise (or verbose if you choose `verbose=True`) summary :
 
 Retrieve a scan and its partner ON or OFF, selecting an IF number and polarization, then calibrate it
 
+.. note::
+    For each scan in the summary `dysh` shows the mean of the VELOCITY, RESTFREQ, DOPFREQ, AZIMUTH and ELEVATIO columns, while `GBTIDL` reports the value of the first integration for a scan. If you use `verbose=True` in `dysh` you get all the integrations.
+
 .. code:: python
 
     >>> psscan = sdfits.getps(152, ifnum=0, plnum=0)

docs/source/examples/subbeamnod.rst

@@ -71,6 +71,10 @@ You can also print a concise (or verbose if you choose `verbose=True`) :meth:`~d
 
 The SubBeamNod scans are 43, 46, and 54.  Retrieve and calibrate a SubBeamNod scan, then plot it
 
+.. note::
+    For each scan in the summary `dysh` shows the mean of the VELOCITY, RESTFREQ, DOPFREQ, AZIMUTH and ELEVATIO columns, while `GBTIDL` reports the value of the first integration for a scan. If you use `verbo
+    se=True` in `dysh` you get all the integrations.
+
 .. code:: python
 
     >>> sbn = sdfits.subbeamnod(scan=43, fdnum=1, ifnum=0, weights='tsys')

docs/source/examples/totalpower.rst

@@ -54,6 +54,10 @@ You can also print a concise (or verbose if you choose `verbose=True`) summary :
 
 Retrieve a scan, selecting and IF number and polarization
 
+.. note::
+    For each scan in the summary `dysh` shows the mean of the VELOCITY, RESTFREQ, DOPFREQ, AZIMUTH and ELEVATIO columns, while `GBTIDL` reports the value of the first integration for a scan. If you use `verbo
+    se=True` in `dysh` you get all the integrations.
+
 .. code:: python
 
     >>> tpscan = sdfits.gettp(152, ifnum=0, plnum=0)

docs/source/for_beta_testers/beta_testing.rst

@@ -40,6 +40,7 @@ Here are examples of feedback on GitHub
 * reporting an issue, `Issue #88 <https://github.com/GreenBankObservatory/dysh/issues/88>`_
 * requesting a modification, `Issue #78 <https://github.com/GreenBankObservatory/dysh/issues/78>`_
 
+.. _beta-install
 
 Installing `dysh`
 =================

docs/source/getting_started/install.rst

@@ -21,6 +21,9 @@ Index <https://pypi.org/project/dysh>`_.
 
     $ pip install dysh
 
+.. warning::
+    `dysh` is currently in development and the above command will install the latest stable version of `dysh` which might not reflect the contents of the documentation. For beta testing please see :ref:`beta-install`.
+
 From github
 ===========
 

docs/source/index.rst

@@ -6,7 +6,7 @@
 `Green Bank Observatory <https:/greenbankobservatory.org>`_
 and the Laboratory for Millimeter-Wave Astronomy (LMA)
 at the `University of Maryland (UMD) <https://www.astro.umd.edu>`_.
-It is intended to be a full replacement for the GBO's current reduction package `GBTIDL <https://www.gb.nrao.edu/GBT/DA/gbtidl/users_guide/>`_.
+It is intended to be an alternative for `GBTIDL <https://www.gb.nrao.edu/GBT/DA/gbtidl/users_guide/>`_, GBO's current spectral line data reduction package.
 
 Contents
 ===============

testdata/gbtidl_spectra/README.md

@@ -0,0 +1,26 @@
+# GBTIDL spectra for testing
+
+All of the raw data used to generate these examples should be available in the [dysh data server](https://www.gb.nrao.edu/dysh/example_data/).
+
+Here we provide the `GBTIDL` commands used to generate individual files.
+
+
+## OnOff L <a name="onoff"></a>
+``` IDL
+filein,"onoff-L/data/TGBT21A_501_11.raw.vegas/TGBT21A_501_11.raw.vegas.A.fits"
+gettp,156,intnum=0
+setframe,"TOPO"
+write_ascii,"onoff-L_gettp_156_intnum_0_TOPO.ascii"
+setframe,"GEO"
+write_ascii,"onoff-L_gettp_156_intnum_0_GEO.ascii"
+setframe,"HEL"
+write_ascii,"onoff-L_gettp_156_intnum_0_HEL.ascii"
+setframe,"BAR"
+write_ascii,"onoff-L_gettp_156_intnum_0_BAR.ascii"
+setframe,"LSR"
+write_ascii,"onoff-L_gettp_156_intnum_0_LSR.ascii"
+setframe,"LSD"
+write_ascii,"onoff-L_gettp_156_intnum_0_LSD.ascii"
+setframe,"GAL"
+write_ascii,"onoff-L_gettp_156_intnum_0_GAL.ascii"
+```