update to version 1.0.0

jtschindler · Feb 14, 2022 · 25035fd · 25035fd
1 parent baf727a
commit 25035fd
Show file tree

Hide file tree

Showing 31 changed files with 52 additions and 54 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.4b0)
+##### (Version 1.0.0)
 
 **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:
 
@@ -32,7 +32,7 @@ At the heart of the *Sculptor* package is the Graphical User Interface, which of
 If you are interested in being involved with this project, please contact Jan-Torge Schindler via [github](https://github.com/jtschindler/sculptor).
 
 **Disclaimer:**
-This project is currently undergoing rapid development. Be advised as the API has not been finalized, yet, fits done with the current version may not work with a future version of the software. The first stable, well-tested release will be version 1.0.0 anticipated for summer 2021.
+Version 1.0.0 is the first stable release version of Sculptor. Be advised that all future 1.x.x versions will adhere to the same API. However API changes might occur between major releases. 
 
 
 [LMFIT]: https://lmfit.github.io/lmfit-py/

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: 4e73a007b21b97cb5e29bf4ca4251b0a
+config: 8cac2b818d84d887fa2158242864050f
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -26,8 +26,7 @@ At the heart of the *Sculptor* package is the Graphical User Interface, which of
 If you are interested in being involved with this project, please contact Jan-Torge Schindler via `github <https://github.com/jtschindler/sculptor>`_.
 
 **Disclaimer:**
-This project is currently undergoing rapid development. Be advised as the API has not been finalized, yet, fits done with the current version may not work with a future version of the software. The first stable, well-tested release will be version 1.0.0 anticipated for summer 2021.
-
+Version 1.0.0 is the first stable release version of Sculptor. Be advised that all future 1.x.x versions will adhere to the same API. However API changes might occur between major releases.
 
 .. toctree::
   :maxdepth: 1

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.4b0',
+    VERSION: '1.0.0',
     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.4b0 documentation</title>
+  <title>Spectral fitting with the Sculptor GUI &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </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.4b0 documentation</title>
+  <title>Index &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </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.4b0 documentation</title>
+  <title>The Sculptor GUI &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </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.4b0 documentation</title>
+  <title>Welcome to Sculptor’s documentation! &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </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.4b0</p>
+<p><strong>Version:</strong> 1.0.0</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>
@@ -226,7 +226,7 @@ <h1>Welcome to Sculptor’s documentation!<a class="headerlink" href="#welcome-t
 <p>At the heart of the <em>Sculptor</em> package is the Graphical User Interface, which offers interactive control to set up and combine multiple spectral models to fully fit the astronomical spectrum of choice. This includes masking of spectral features, defining fit regions, and setting of fit parameter boundaries. The framework allows to add interdependent fit parameters (e.g., to couple the FWHM of multiple emission/absorption lines).</p>
 <p>If you are interested in being involved with this project, please contact Jan-Torge Schindler via <a class="reference external" href="https://github.com/jtschindler/sculptor">github</a>.</p>
 <p><strong>Disclaimer:</strong>
-This project is currently undergoing rapid development. Be advised as the API has not been finalized, yet, fits done with the current version may not work with a future version of the software. The first stable, well-tested release will be version 1.0.0 anticipated for summer 2021.</p>
+Version 1.0.0 is the first stable release version of Sculptor. Be advised that all future 1.x.x versions will adhere to the same API. However API changes might occur between major releases.</p>
 <div class="toctree-wrapper compound">
 <p class="caption"><span class="caption-text">Getting Started:</span></p>
 <ul>

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.4b0 documentation</title>
+  <title>Installation &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </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.4b0 documentation</title>
+  <title>License &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </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.4b0 documentation</title>
+  <title>The Masks &amp; Models Module &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </div>
 
 

diff --git a/docs/build/html/my_extension.html b/docs/build/html/my_extension.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Example extension Module &mdash; Sculptor 0.4b0 documentation</title>
+  <title>Example extension Module &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </div>
 
 

diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv
diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Python Module Index &mdash; Sculptor 0.4b0 documentation</title>
+  <title>Python Module Index &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -65,7 +65,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </div>
 
 

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

diff --git a/docs/build/html/scripting_sculptor_1.html b/docs/build/html/scripting_sculptor_1.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Scripting Sculptor 01 - Modelling the example spectrum in a script &mdash; Sculptor 0.4b0 documentation</title>
+  <title>Scripting Sculptor 01 - Modelling the example spectrum in a script &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </div>
 
 

diff --git a/docs/build/html/scripting_sculptor_2.html b/docs/build/html/scripting_sculptor_2.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Scripting Sculptor 02 - Analysing model fits with SpecAnalysis &mdash; Sculptor 0.4b0 documentation</title>
+  <title>Scripting Sculptor 02 - Analysing model fits with SpecAnalysis &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </div>
 
 

diff --git a/docs/build/html/scripting_sculptor_3.html b/docs/build/html/scripting_sculptor_3.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Scripting Sculptor 03 - Fitting and Analzying models using MCMC &mdash; Sculptor 0.4b0 documentation</title>
+  <title>Scripting Sculptor 03 - Fitting and Analzying models using MCMC &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </div>
 
 

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.4b0 documentation</title>
+  <title>Search &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -65,7 +65,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </div>
 
 

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

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.4b0 documentation</title>
+  <title>The SpecFit Module &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </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.4b0 documentation</title>
+  <title>The SpecModel Module &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </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.4b0 documentation</title>
+  <title>The SpecOneD Module &mdash; Sculptor 1.0.0 documentation</title>
 
 
 
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                0.4b0
+                1.0.0
               </div>
-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.4b0 documentation</title>
+      <title>Spectral fitting with the Sculptor GUI &mdash; Sculptor 1.0.0 documentation</title>
@@ Expand Down Expand Up / @@ -64,7 +64,7 @@ @@
                   <div class="version">
-.4b0
+.0.0
                   </div>
@@ Expand Down @@