updated documentation to v.1.1.0

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: 8cac2b818d84d887fa2158242864050f
+config: 8db62d458456ab0b65a0e4dffadf66a1
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/installation.rst.txt

@@ -12,39 +12,59 @@ To do this simply clone the repository to your folder of choice.
 
   git clone https://github.com/jtschindler/sculptor.git
 
+The current version of Sculptor is designed to work with python >= 3.9.
 
-2. Install requirements
-#######################
+2. Installing Sculptor and its requirements
+###########################################
 
 Navigate to the main folder of sculptor. It should contain the *setup.py* file as well as *requirements.txt*, *conda_requirements.yml*, and *environment.yml*.
 
-2.1 Installing requirements with a new conda environment (Recommended)
-**********************************************************************
+2.1 Installing Sculptor via conda (Recommended)
+***********************************************
 
-The sculptor github repository provides an environment.yml file. It automatically creates the  *sculptor-env* environment installing all necessary dependencies with the following command:
+While some may prefer a pure pip installation, I have run into issues with installing PyQt5 and pytables via pip on new Mac OSX M1/M2 machines. Therefore, I recommend to use the provided environment.yml file instead.
+
+It automatically creates the  *sculptor* environment installing all necessary dependencies with the following command:
 
 .. code-block::
 
   conda env create --file environment.yml
 
-2.2 Installing requirements in an existing conda environment
-************************************************************
+The environment is crearted using python 3.10. If a different python version is needed, please modify your version of the environment.yml file. Following the creating of the environment activate it via
+
+.. code-block::
+
+  conda activate sculptor
+
+and then install Sculptor with
+
+.. code-block::
+
+  pip install -e .
+
+This has been tested on a Mac OSX with a M2 chip, recently.
 
-There are basically two ways to make sure all requirements are installed, when working with an existing conda environment. The more convenient way makes use of the conda_requirements.yaml by updating the environment of choice [myenv]:
+2.2 Installing Sculptor (using setup.py via pip)
+************************************************
+
+One can attempt a pure pip installation. Due to issues with pytables and PyQt5 installations via pip on Mac OSX M1/M2 machines, one needs to first install these packages independently:
 
 .. code-block::
 
-  conda env update --name [myenv] --file conda_requirements.yml
+  pip install PyQt5
+  pip install tables
 
-Alternatively, one can open the conda_requirements.yml with a text editor and manually install all dependencies. The environment of choice should be activated first. Note, that *lmfit* and *corner* can only be installed via pip. Therefore one has to install pip in the active environment, if it is not installed already:
+Then you need to navigate into the main package folder with the setup.py file and execute:
 
 .. code-block::
 
-  conda install pip
+  pip install -e .
+
+This will install all of the remaining dependencies and the Sculptor package itself.
 
+2.3 Installing Sculptor (using requirements.txt via pip)
+********************************************************
 
-2.3 Installing requirements via pip
-***********************************
 In the sculptor github repository you will find a 'requirements.txt', which allows you to install the necessary requirements using pip from the main sculptor directory:
 
 .. code-block::
@@ -53,18 +73,16 @@ In the sculptor github repository you will find a 'requirements.txt', which allo
 
 If you are managing your python installation with Anaconda, this can work as well as long as you have pip installed in your Anaconda working environment. However, it may lead to issues if a pip version and an anaconda version of the same package (e.g., astropy) is installed.
 
-
-3. Install sculptor from the cloned repository
-##############################################
-
-With all requirements fulfilled, install Sculptor via
+In the same folder you then execute:
 
 .. code-block::
 
-  python setup.py install
+  pip install -e .
+
+This will install the Sculptor package.
 
 
-4. Open up the sculptor GUI
+3. Open up the sculptor GUI
 ###########################
 
 To test whether the installation was successful, open your terminal and simply type
@@ -74,3 +92,9 @@ To test whether the installation was successful, open your terminal and simply t
   run_sculptor
 
 If this opens up the Sculptor GUI, the installation was a success!
+
+To test Sculptor further one can also load the example spectrum via
+
+.. code-block::
+
+  run_sculptor --ex=True

docs/build/html/_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -130,7 +130,7 @@ ul.search li a {
     font-weight: bold;
 }
 
-ul.search li div.context {
+ul.search li p.context {
     color: #888;
     margin: 2px 0 0 30px;
     text-align: left;
@@ -222,7 +222,7 @@ table.modindextable td {
 /* -- general body styles --------------------------------------------------- */
 
 div.body {
-    min-width: 450px;
+    min-width: 360px;
     max-width: 800px;
 }
 
@@ -237,16 +237,6 @@ a.headerlink {
     visibility: hidden;
 }
 
-a.brackets:before,
-span.brackets > a:before{
-    content: "[";
-}
-
-a.brackets:after,
-span.brackets > a:after {
-    content: "]";
-}
-
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
@@ -335,12 +325,16 @@ p.sidebar-title {
     font-weight: bold;
 }
 
+nav.contents,
+aside.topic,
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
 
+nav.contents,
+aside.topic,
 div.topic {
     border: 1px solid #ccc;
     padding: 7px;
@@ -379,13 +373,17 @@ div.body p.centered {
 
 div.sidebar > :last-child,
 aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
     margin-bottom: 0;
 }
 
 div.sidebar::after,
 aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -428,10 +426,6 @@ table.docutils td, table.docutils th {
     border-bottom: 1px solid #aaa;
 }
 
-table.footnote td, table.footnote th {
-    border: 0 !important;
-}
-
 th {
     text-align: left;
     padding-right: 5px;
@@ -508,6 +502,63 @@ table.hlist td {
     vertical-align: top;
 }
 
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+	font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+    background-color: transparent;
+    font-weight: bold;
+}
+
+.sig-name {
+	font-size: 1.1em;
+}
+
+code.descname {
+    font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+    background-color: transparent;
+}
+
+.optional {
+    font-size: 1.3em;
+}
+
+.sig-paren {
+    font-size: larger;
+}
+
+.sig-param.n {
+	font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+	font-family: unset;
+}
+
+.sig.c   .k, .sig.c   .kt,
+.sig.cpp .k, .sig.cpp .kt {
+	color: #0033B3;
+}
+
+.sig.c   .m,
+.sig.cpp .m {
+	color: #1750EB;
+}
+
+.sig.c   .s, .sig.c   .sc,
+.sig.cpp .s, .sig.cpp .sc {
+	color: #067D17;
+}
+
 
 /* -- other body styles ----------------------------------------------------- */
 
@@ -558,19 +609,26 @@ ul.simple p {
     margin-bottom: 0;
 }
 
-dl.footnote > dt,
-dl.citation > dt {
+aside.footnote > span,
+div.citation > span {
     float: left;
-    margin-right: 0.5em;
 }
-
-dl.footnote > dd,
-dl.citation > dd {
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+  padding-right: 0.5em;
+}
+aside.footnote > p {
+  margin-left: 2em;
+}
+div.citation > p {
+  margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
     margin-bottom: 0em;
 }
-
-dl.footnote > dd:after,
-dl.citation > dd:after {
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
     content: "";
     clear: both;
 }
@@ -587,10 +645,6 @@ dl.field-list > dt {
     padding-right: 5px;
 }
 
-dl.field-list > dt:after {
-    content: ":";
-}
-
 dl.field-list > dd {
     padding-left: 0.5em;
     margin-top: 0em;
@@ -634,14 +688,6 @@ dl.glossary dt {
     font-size: 1.1em;
 }
 
-.optional {
-    font-size: 1.3em;
-}
-
-.sig-paren {
-    font-size: larger;
-}
-
 .versionmodified {
     font-style: italic;
 }
@@ -682,8 +728,9 @@ dl.glossary dt {
 
 .classifier:before {
     font-style: normal;
-    margin: 0.5em;
+    margin: 0 0.5em;
     content: ":";
+    display: inline-block;
 }
 
 abbr, acronym {
@@ -707,6 +754,7 @@ span.pre {
     -ms-hyphens: none;
     -webkit-hyphens: none;
     hyphens: none;
+    white-space: nowrap;
 }
 
 div[class*="highlight-"] {
@@ -770,8 +818,12 @@ div.code-block-caption code {
 
 table.highlighttable td.linenos,
 span.linenos,
-div.doctest > div.highlight span.gp {  /* gp: Generic.Prompt */
-    user-select: none;
+div.highlight span.gp {  /* gp: Generic.Prompt */
+  user-select: none;
+  -webkit-user-select: text; /* Safari fallback only */
+  -webkit-user-select: none; /* Chrome/Safari */
+  -moz-user-select: none; /* Firefox */
+  -ms-user-select: none; /* IE10+ */
 }
 
 div.code-block-caption span.caption-number {
@@ -786,16 +838,6 @@ div.literal-block-wrapper {
     margin: 1em 0;
 }
 
-code.descname {
-    background-color: transparent;
-    font-weight: bold;
-    font-size: 1.2em;
-}
-
-code.descclassname {
-    background-color: transparent;
-}
-
 code.xref, a code {
     background-color: transparent;
     font-weight: bold;