Minor updates to documentation.

amisr · Nov 22, 2024 · 98319f4 · 98319f4
1 parent ba35a76
commit 98319f4
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 293 deletions.
diff --git a/README.rst b/README.rst
@@ -65,6 +65,11 @@ Documentation
 
 Full documentation for amisrsynthdata is available on `ReadTheDocs <https://amisrsynthdata.readthedocs.io>`_.
 
+Source Code Repository
+----------------------
+
+The source code for amisrsynthdata is available on `GitHub <https://github.com/amisr/amisrsynthdata>`_.
+
 Contributing
 ------------
 

diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -74,24 +74,25 @@ The amisrsynthdata package contains three classes: ``Radar``, ``Ionosphere``, an
 .. code-block:: python
 
   from amisrsynthdata.syntheticdata import SyntheticData
-
+  
   sd = SyntheticData(config)
-
+  
   # Get get output range gate positions and electron density
-  fov_glat = sd.Geomag['Latitude']
-  fov_glon = sd.Geomag['Longitude']
-  fov_galt = sd.Geomag['Altitude']
-  fov_ne = sd.FittedParams['Ne']
+  fov_glat = sd.radar.lat
+  fov_glon = sd.radar.lon
+  fov_galt = sd.radar.alt
+  fov_ne = sd.ne
+  
+  # Also queary the ionosphre functions
+  Ne = sd.iono.density(utime, fov_glat, fov_glon, fov_galt)
 
-  # Can also get range gate positions from Radar
-  glat = sd.radar.lat
-  glon = sd.radar.lon
-  galt = sd.radar.alt
+Note that all functionality of the ``Radar`` and ``Ionosphere`` classes are available through the ``SyntheticData`` class.  ``SyntheticData`` contains an instance of the ``Radar`` class named ``radar`` and an instance of the ``Ionosphere`` class named ``iono``.
 
-  # And access Ionosphere functions directly
-  Ne = sd.iono.density(utime, glat, glon, galt)
+Jupyter Notebook Tutorial
+*************************
+
+A jupyter ntoebook tutorial demonstrating the basic python functionality of ``amisrsynthdata`` is `available in the GitHub repository <https://github.com/amisr/amisrsynthdata/blob/main/tutorial.ipynb>'_.
 
-Note that all functionality of the ``Radar`` and ``Ionosphere`` classes are available through the ``SyntheticData`` class.  ``SyntheticData`` contains an instance of the ``Radar`` class named ``radar`` and an instance of the ``Ionosphere`` class named ``iono``.
 
 Benchmarking
 ------------