documentation

tamarervin · Apr 18, 2022 · 262a864 · 262a864
1 parent 8ec6cf1
commit 262a864
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 185 deletions.
diff --git a/SolAster/examples/full_pipeline.ipynb b/SolAster/examples/full_pipeline.ipynb
diff --git a/SolAster/tools/__init__.py b/SolAster/tools/__init__.py
@@ -8,7 +8,7 @@
 
 from SolAster.tools.lbc_funcs import get_u, get_v, limb_polynomial
 
-from SolAster.tools.rvs import rvs
+from SolAster.tools.rvs import *
 
 from SolAster.tools.settings import BaseDir, CsvDir, ImgDir, Scaling, HARPSN, NEID
 

diff --git a/SolAster/tools/lbc_funcs.py b/SolAster/tools/lbc_funcs.py
@@ -17,13 +17,13 @@ def get_u(ll):
 
     Parameters
     ----------
-    ll : float
+    ll: float
         wavelength
 
     Returns
     -------
-    vl : float
-        coefficient v based on wavelength
+    ul: float
+        coefficient u based on wavelength
 
     """
 
@@ -45,12 +45,12 @@ def get_v(ll):
 
     Parameters
     ----------
-    ll : float
+    ll: float
         wavelength
 
     Returns
     -------
-    vl : float
+    vl: float
         coefficient v based on wavelength
 
     """
@@ -69,20 +69,19 @@ def get_v(ll):
 
 def limb_polynomial(imap):
     """
-    function to calculate limb darkening correction polynomial based on IDl function:
-    https://hesperia.gsfc.nasa.gov/ssw/gen/idl/solar/darklimb_correct.pro
-
-    Parameters
-    ----------
-    imap
-        UNCORRECTED Sunpy map object (Intensitygram)
-
-    Returns
-    -------
-    Lij : array_like
-        limb-darkening polynomial array
-
-    """
+        function to calculate limb darkening correction polynomial based on IDl function:
+           https://hesperia.gsfc.nasa.gov/ssw/gen/idl/solar/darklimb_correct.pro
+       Parameters
+       ----------
+       imap: map type
+            UNCORRECTED Sunpy map object (Intensitygram)
+
+
+       Returns
+       -------
+        Lij: array_like
+            limb-darkening polynomial array
+       """
 
     # get data
     data = imap.data

diff --git a/mkdocs/docs/install.md b/mkdocs/docs/install.md
@@ -2,10 +2,10 @@
 
 # Build conda environment
 
-* update dependencies in conda_env.yml [file](conda_env.yml)   
+* update dependencies in conda_env.yml [file](../conda_env.yml)   
 * run the following from the folder containing the .yml file
     * ``conda env create -f conda_env.yml``  
-* to add new dependencies, update conda_env.yml [file](conda_env.yml)  
+* to add new dependencies, update conda_env.yml [file](../conda_env.yml)  
 * run the following from the folder containing the .yml file  
     * ``conda env update -f conda_env.yml``
 

diff --git a/mkdocs/docs/package/coord_funcs.md b/mkdocs/docs/package/coord_funcs.md
@@ -1,2 +1,6 @@
 # Coordinate Transformations Module
-::: SolAster.tools.coord_funcs
+
+::: SolAster.tools.coord_funcs
+    rendering:
+      show_root_heading: false
+      show_source: false
diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml
@@ -60,6 +60,8 @@ plugins:
       ignore_h1_titles: True
   - mkdocstrings:
       docstring_style: numpy
+#      watch:
+#        - SolAster/SolAster
 
 # extensions
 markdown_extensions: