Readthedocs pull request

docs/requirements.txt

@@ -7,3 +7,5 @@ scipy
 fitsio
 matplotlib
 healpy
+pandas
+sphinx-rtd-theme

docs/source/api.rst

@@ -4,7 +4,11 @@ API for lusee
 .. autosummary::
    :toctree: generated
 
+   lusee.Observation
+   lusee.Beam
    lusee.Simulation
    lusee.Satellite
    lusee.ObservedSatellite
-
+   lusee.MonoSkyModels
+   lusee.SkyModels
+   lusee.LunarCalendar

docs/source/conf.py

@@ -5,7 +5,7 @@
 
 from unittest import mock
 
-sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath('../../'))
 
 # -- Project information
 

docs/source/usage.rst

@@ -6,52 +6,101 @@ Usage
 Installation
 ------------
 
-To use luseepy, go to the GitHub repo
+To use luseepy, install the LuSEE-Night Docker image (For more information, see https://github.com/lusee-night/luseepy/tree/main/docker):
+
+**The "unity" Image**
+
+This is the minimal useable image based on requirements-foundation.txt. The main "Dockerfile" in the "docker" folder uses a build-arg argument, which also has a reasonable default. For example, building the "unity" image is done like this:
 
 .. code-block:: console
 
-   (.venv) $ # commands here
+    $ docker build . -f docker/Dockerfile-unity-luseepy -t lusee/lusee-night-unity-luseepy:1.0 --build-arg reqs=requirements-unity-luseepy.txt
 
-As an alternative, there are Docker images in development (TBD).
+**Jupyter**
 
-The Simulator
+This image also includes Jupyter Lab software. Jupyter is not started automatically, i.e. by default the user gets bash running and a functional Python/refspec/luseepy environment. To get Jupyter running, one first starts the container like this (or in a similar manner):
+
+.. code-block:: console
+
+    $ docker run -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes -e JUPYTER_TOKEN=docker lusee/lusee-night-unity-luseepy:0.1
+
+Once the container is running, this command is invoked to bring up Jupyter:
+
+.. code-block:: console
+
+    $ jupyter lab --allow-root --ip 0.0.0.0 --port 8888
+
+The port 8888 can be mapped to any other convenient port on the host machine, and then access through localhost.
+
+The Observation
 --------------
 
-The main simulator class
+.. automodule:: lusee.Observation
+   :members:
 
-.. autoclass:: lusee.Simulator
+The Beams
+--------------
 
+.. automodule:: lusee.Beam
+   :members:
 
-Beam preparation
+The Gaussian Beam
+--------------
 
-.. autofunction:: lusee.Simulator.prepare_beams
+.. automodule:: lusee.BeamGauss
+   :members:
 
-The "simulate" method
+The Beam Couplings
+--------------
 
-.. autofunction:: lusee.Simulator.simulate
+.. automodule:: lusee.BeamCouplings
+   :members:
 
-Writing out data
+The Simulator
+--------------
 
-.. autofunction:: lusee.Simulator.write
+.. automodule:: lusee.Simulation
+   :members:
 
 The Satellite classes
 ---------------------
 
-.. autoclass:: lusee.Satellite
+.. automodule:: lusee.Satellite
+   :members:
 
-.. autoclass:: lusee.ObservedSatellite
+The Monopole Sky Model classes
+----------------------
 
-.. autofunction:: lusee.ObservedSatellite.get_transit_indices   
+.. automodule:: lusee.MonoSkyModels
+   :members:
 
-The Sky Models classes
+The Sky Model classes
 ----------------------
 
-.. autoclass:: lusee.GalCenter
+.. automodule:: lusee.SkyModels
+   :members:
 
-.. autoclass:: lusee.FitsSky
 
+The Lunar Calendar
+----------------------
 
-'Map alm'
+.. automodule:: lusee.LunarCalendar
+   :members:
 
-.. autofunction:: lusee.FitsSky.get_alm
+The Throughput
+--------------
+
+.. automodule:: lusee.Throughput
+   :members:
+
+The Data
+--------------
+
+.. automodule:: lusee.Data
+   :members:
+
+The PCA Analyzer
+--------------
 
+.. automodule:: lusee.PCAanalyzer
+   :members: