Improved autodocs

tomasstolker · Nov 11, 2019 · 24f98d9 · 24f98d9
1 parent dd9d400
commit 24f98d9
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/species/plot/plot_color.py b/species/plot/plot_color.py
@@ -262,6 +262,8 @@ def plot_color_magnitude(colorbox=None,
             #
             # if item[0] == 'HR 8799 b':
             #     label = 'Directly imaged'
+            # elif item[0] == 'beta Pic b':
+            #     label = 'This study'
             # else:
             #     label = None
 
@@ -555,6 +557,8 @@ def plot_color_color(colorbox,
             #
             # if item[0] == 'HR 8799 b':
             #     label = 'Directly imaged'
+            # elif item[0] == 'beta Pic b':
+            #     label = 'This study'
             # else:
             #     label = None
 

diff --git a/species/read/read_model.py b/species/read/read_model.py
@@ -192,6 +192,11 @@ def get_model(self,
                   specres=None,
                   magnitude=False):
         """
+        Function to extract a model spectrum with a multidimensional interpolation of the model
+        grid. The parameters values should therefore lie within the boundaries of the grid points
+        that are stored in the database. The stored grid points can be inspected with
+        :func:`~species.read.read_model.ReadModel.get_points`.
+
         Parameters
         ----------
         model_par : dict
@@ -309,6 +314,10 @@ def get_model(self,
     def get_data(self,
                  model_par):
         """
+        Function to extract a model spectra without interpolation for parameter values that are
+        stored within the database. The stored grid points can be inspected with
+        :func:`~species.read.read_model.ReadModel.get_points`.
+
         Parameters
         ----------
         model_par : dict