updated docs and fixed minor mistakes in documentation. upgraded to v…

…ersion 0.3b0
jtschindler · Jun 21, 2021 · 6aa8285 · 6aa8285
1 parent fe00d8a
commit 6aa8285
Show file tree

Hide file tree

Showing 22 changed files with 41 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ Interactive modeling of (electromagnetic) astronomical spectra.
 
 For installation instructions and documentation visit [Sculptor's ReadTheDocs]
 
-##### (Version 0.2b0)
+##### (Version 0.3b0)
 
 **Sculptor** is a high level API and Graphical User Interface around [LMFIT](https://lmfit.github.io/lmfit-py/) tailored specifically for the analysis of astronomical spectra. This package is designed to facilitate reproducible scientific results and easy to inspect model fits in an open source framework. For this purpose the *Sculptor* package introduces four core python modules and a Graphical User Interface for interactive control:
 

diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 70037d2f0321c440c30214d8395eb63d
+config: f3c3c86d81fa2e4b7046c5b9ccc4e528
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.2b0',
+    VERSION: '0.3b0',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/build/html/first_fit.html b/docs/build/html/first_fit.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Spectral fitting with the Sculptor GUI &mdash; Sculptor 0.2b0 documentation</title>
+  <title>Spectral fitting with the Sculptor GUI &mdash; Sculptor 0.3b0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.2b0
+                0.3b0
               </div>
 
 

diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Index &mdash; Sculptor 0.2b0 documentation</title>
+  <title>Index &mdash; Sculptor 0.3b0 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                0.2b0
+                0.3b0
               </div>
 
 

diff --git a/docs/build/html/getting_started.html b/docs/build/html/getting_started.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>The Sculptor GUI &mdash; Sculptor 0.2b0 documentation</title>
+  <title>The Sculptor GUI &mdash; Sculptor 0.3b0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.2b0
+                0.3b0
               </div>
 
 

diff --git a/docs/build/html/index.html b/docs/build/html/index.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Welcome to Sculptor’s documentation! &mdash; Sculptor 0.2b0 documentation</title>
+  <title>Welcome to Sculptor’s documentation! &mdash; Sculptor 0.3b0 documentation</title>
 
 
 
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.2b0
+                0.3b0
               </div>
 
 
@@ -212,7 +212,7 @@
 </style>
 <div class="section" id="welcome-to-sculptor-s-documentation">
 <h1>Welcome to Sculptor’s documentation!<a class="headerlink" href="#welcome-to-sculptor-s-documentation" title="Permalink to this headline">¶</a></h1>
-<p><strong>Version:</strong> 0.2b0</p>
+<p><strong>Version:</strong> 0.3b0</p>
 <p><strong>Sculptor</strong> is a high level API and Graphical User Interface around <a class="reference external" href="https://lmfit.github.io/lmfit-py/">LMFIT</a> tailored specifically for the analysis of astronomical spectra. This package is designed to facilitate reproducible scientific results and easy to inspect model fits in an open source framework. For this purpose the <em>Sculptor</em> package introduces four core python modules and a Graphical User Interface for interactive control:</p>
 <p>1. <strong>SpecOneD</strong>:
 The <em>SpecOneD</em> module introduces the SpecOneD class, which is designed to store and manipulate 1D astronomical spectral data.</p>

diff --git a/docs/build/html/installation.html b/docs/build/html/installation.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Installation &mdash; Sculptor 0.2b0 documentation</title>
+  <title>Installation &mdash; Sculptor 0.3b0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.2b0
+                0.3b0
               </div>
 
 

diff --git a/docs/build/html/license.html b/docs/build/html/license.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>License &mdash; Sculptor 0.2b0 documentation</title>
+  <title>License &mdash; Sculptor 0.3b0 documentation</title>
 
 
 
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.2b0
+                0.3b0
               </div>
 
 

diff --git a/docs/build/html/masksmodels.html b/docs/build/html/masksmodels.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>The Masks &amp; Models Module &mdash; Sculptor 0.2b0 documentation</title>
+  <title>The Masks &amp; Models Module &mdash; Sculptor 0.3b0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.2b0
+                0.3b0
               </div>
 
 

diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv
diff --git a/docs/build/html/search.html b/docs/build/html/search.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Search &mdash; Sculptor 0.2b0 documentation</title>
+  <title>Search &mdash; Sculptor 0.3b0 documentation</title>
 
 
 
@@ -65,7 +65,7 @@
 
 
               <div class="version">
-                0.2b0
+                0.3b0
               </div>
 
 

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git a/docs/build/html/specfit.html b/docs/build/html/specfit.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>The SpecFit Module &mdash; Sculptor 0.2b0 documentation</title>
+  <title>The SpecFit Module &mdash; Sculptor 0.3b0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.2b0
+                0.3b0
               </div>
 
 

diff --git a/docs/build/html/specmodel.html b/docs/build/html/specmodel.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>The SpecModel Module &mdash; Sculptor 0.2b0 documentation</title>
+  <title>The SpecModel Module &mdash; Sculptor 0.3b0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.2b0
+                0.3b0
               </div>
 
 

diff --git a/docs/build/html/speconed.html b/docs/build/html/speconed.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>The SpecOneD Module &mdash; Sculptor 0.2b0 documentation</title>
+  <title>The SpecOneD Module &mdash; Sculptor 0.3b0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.2b0
+                0.3b0
               </div>
 
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -26,8 +26,8 @@
 author = 'Jan-Torge Schindler'
 
 # The full version, including alpha/beta/rc tags
-version = '0.2b0'
-release = '0.2b0'
+version = '0.3b0'
+release = '0.3b0'
 
 # html_logo = 'sculptor_logo.png'
 

diff --git a/sculptor/specanalysis.py b/sculptor/specanalysis.py
@@ -87,7 +87,7 @@ def analyze_emission_feature(specfit, feature_name, model_names,
     :type cosmology: astropy.cosmology class
     :param fwhm_method: Method to use for calculating the FWHM. Possible
         values are 'sign' or 'spline' (default).
-    :type: string
+    :type fwhm_method: string
     :return: Dictionary with measurement results (with units)
     :rtype: dict
     """
@@ -382,7 +382,7 @@ def analyze_mcmc_results(foldername, specfit, continuum_dict,
         will be called by this procedure.
     :type emission_feature_dictlist: list of dictionary
     :param redshift: Source redshift
-    :type: float
+    :type redshift: float
     :param cosmology: Cosmology for calculation of absolute properties
     :type cosmology: astropy.cosmology.Cosmology
     :param emfeat_meas: This keyword argument allows to specify the list of
@@ -553,7 +553,7 @@ def _mcmc_analyze(foldername, specfit, specmodel_index, mcmc_df, continuum_dict,
         will be called by this procedure.
     :type emission_feature_dictlist: dictionary
     :param redshift: Source redshift
-    :type: float
+    :type redshift: float
     :param cosmology: Cosmology for calculation of absolute properties
     :type cosmology: astropy.cosmology.Cosmology
     :param mode: A string indicating whether an emission feature by itself
@@ -721,8 +721,6 @@ def analyze_resampled_results(specfit, foldername, resampled_df_name,
     * 'disp_range' - 2 element list holding the lower and upper dispersion \
         boundaries flux density integration.
 
-
-
     :param specfit: Sculptor model fit (SpecFit object) containing the
         information about the science spectrum, the SpecModels and parameters.
     :type specfit: sculptor.specfit.SpecFit
@@ -740,7 +738,7 @@ def analyze_resampled_results(specfit, foldername, resampled_df_name,
         will be called by this procedure.
     :type emission_feature_dictlist: list of dictionary
     :param redshift: Source redshift
-    :type: float
+    :type redshift: float
     :param cosmology: Cosmology for calculation of absolute properties
     :type cosmology: astropy.cosmology.Cosmology
     :param emfeat_meas: This keyword argument allows to specify the list of
@@ -821,7 +819,7 @@ def _resampled_analyze(specfit, resampled_df, foldername, continuum_dict,
         will be called by this procedure.
     :type emission_feature_dictlist: list of dictionary
     :param redshift: Source redshift
-    :type: float
+    :type redshift: float
    :param cosmology: Cosmology for calculation of absolute properties
     :type cosmology: astropy.cosmology.Cosmology
     :param emfeat_meas: This keyword argument allows to specify the list of

diff --git a/sculptor_extensions/qso.py b/sculptor_extensions/qso.py
@@ -281,10 +281,12 @@ def template_model(x, amp, z, fwhm, intr_fwhm, templ_disp=None,
     :type templ_disp: np.ndarray
     :param templ_fluxden: Flux density of the template.
     :type templ_fluxden: templ_fluxden: np.ndarray
-    # :param templ_disp_unit: Dispersion unit of the template. This should be \
-    #     an astropy Unit, Quantity, IrreducibleUnit or CompositeUnit.
-    # :param templ_fluxden_unit: Flux density unit of the template. This should \
-    #     be an astropy Unit, Quantity, IrreducibleUnit or CompositeUnit.
+    :param templ_disp_unit_str: Dispersion unit of the template as a string
+        in astropy cds format.
+    :type templ_fluxden_unit_str: str
+    :param templ_fluxden_unit: Flux density unit of the template as a string
+        in astropy cds format.
+    :type templ_disp_unit_str: str
     :return: Template model as a Scipy interpolation
 
     """

diff --git a/setup.py b/setup.py
@@ -14,7 +14,7 @@
     from distutils.command.build_py import build_py
 
 setup(name='sculptor',
-      version='0.2b0',
+      version='0.3b0',
       description='Interactive modeling of (electromagnetic) astronomical spectra',
       long_description=long_description,
       long_description_content_type='text/markdown',
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,7 @@ @@
       <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-      <title>Spectral fitting with the Sculptor GUI &mdash; Sculptor 0.2b0 documentation</title>
+      <title>Spectral fitting with the Sculptor GUI &mdash; Sculptor 0.3b0 documentation</title>
@@ Expand Down Expand Up / @@ -64,7 +64,7 @@ @@
                   <div class="version">
-.2b0
+.3b0
                   </div>
@@ Expand Down @@