PyPI installable version 1.0.9

mpes-kit · Aug 24, 2020 · 4f43b1c · 4f43b1c
1 parent e139504
commit 4f43b1c
Show file tree

Hide file tree

Showing 23 changed files with 92 additions and 68 deletions.
diff --git a/README.md b/README.md
@@ -24,7 +24,11 @@ pip install git+https://github.com/mpes-kit/mpes.git
 pip install --upgrade git+https://github.com/mpes-kit/mpes.git
 ```
 
-PyPI installation coming soon...
+3. PyPI installation
+
+```
+pip install mpes
+```
 
 ### Documentation & citation
 

diff --git a/docs/I01_start.rst b/docs/I01_start.rst
@@ -17,14 +17,22 @@ Install from git repository
 	pip install git+https://github.com/RealPolitiX/mpes.git
 
 
-Install and upgrade to the latest version
+Install and upgrade to the latest version from git repository
 
 
 .. code-block:: bash
 
 	pip install --upgrade git+https://github.com/mpes-kit/mpes.git
 
 
+Install the latest packaged version on PyPI
+
+
+.. code-block:: bash
+
+	pip install mpes
+
+
 Dependencies
 #############
 

diff --git a/docs/doctrees/I01_start.doctree b/docs/doctrees/I01_start.doctree
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/html/.buildinfo b/docs/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: 50e5207065de76f9c430ee859025dc36
+config: d2a7318df56a5b88d61f2e511618fa46
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/I01_start.html b/docs/html/I01_start.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>How to start &mdash; mpes 1.0.8 documentation</title>
+  <title>How to start &mdash; mpes 1.0.9 documentation</title>
 
 
 
@@ -35,8 +35,8 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="mpes 1.0.8 documentation" href="index.html"/>
-        <link rel="next" title="Overview of submodules" href="I02_overview.html"/>
+    <link rel="top" title="mpes 1.0.9 documentation" href="index.html"/>
+        <link rel="next" title="Overview of modules" href="I02_overview.html"/>
         <link rel="prev" title="mpes documentation" href="index.html"/> 
 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                1.0.8
+                1.0.9
               </div>
 
 
@@ -97,7 +97,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#file-formats">File formats</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="I02_overview.html">Overview of submodules</a></li>
+<li class="toctree-l1"><a class="reference internal" href="I02_overview.html">Overview of modules</a></li>
 <li class="toctree-l1"><a class="reference internal" href="I03_usenotes.html">Usage notes</a></li>
 </ul>
 <ul>
@@ -178,10 +178,14 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install git+https://github.com/RealPolitiX/mpes.git
 </pre></div>
 </div>
-<p>Install and upgrade to the latest version</p>
+<p>Install and upgrade to the latest version from git repository</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install --upgrade git+https://github.com/mpes-kit/mpes.git
 </pre></div>
 </div>
+<p>Install the latest packaged version on PyPI</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install mpes
+</pre></div>
+</div>
 </div>
 <div class="section" id="dependencies">
 <h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
@@ -214,7 +218,7 @@ <h2>File formats<a class="headerlink" href="#file-formats" title="Permalink to t
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="I02_overview.html" class="btn btn-neutral float-right" title="Overview of submodules" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="I02_overview.html" class="btn btn-neutral float-right" title="Overview of modules" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
         <a href="index.html" class="btn btn-neutral" title="mpes documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -248,7 +252,7 @@ <h2>File formats<a class="headerlink" href="#file-formats" title="Permalink to t
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.8',
+            VERSION:'1.0.9',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true,

diff --git a/docs/html/I02_overview.html b/docs/html/I02_overview.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview of modules &mdash; mpes 1.0.8 documentation</title>
+  <title>Overview of modules &mdash; mpes 1.0.9 documentation</title>
 
 
 
@@ -35,7 +35,7 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="mpes 1.0.8 documentation" href="index.html"/>
+    <link rel="top" title="mpes 1.0.9 documentation" href="index.html"/>
         <link rel="next" title="Usage notes" href="I03_usenotes.html"/>
         <link rel="prev" title="How to start" href="I01_start.html"/> 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                1.0.8
+                1.0.9
               </div>
 
 
@@ -233,7 +233,7 @@ <h2>Description<a class="headerlink" href="#description" title="Permalink to thi
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.8',
+            VERSION:'1.0.9',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true,

diff --git a/docs/html/I03_usenotes.html b/docs/html/I03_usenotes.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Usage notes &mdash; mpes 1.0.8 documentation</title>
+  <title>Usage notes &mdash; mpes 1.0.9 documentation</title>
 
 
 
@@ -35,9 +35,9 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="mpes 1.0.8 documentation" href="index.html"/>
+    <link rel="top" title="mpes 1.0.9 documentation" href="index.html"/>
         <link rel="next" title="Base classes (mpes.base)" href="base.html"/>
-        <link rel="prev" title="Overview of submodules" href="I02_overview.html"/> 
+        <link rel="prev" title="Overview of modules" href="I02_overview.html"/> 
 
 
   <script src="_static/js/modernizr.min.js"></script>
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                1.0.8
+                1.0.9
               </div>
 
 
@@ -92,7 +92,7 @@
 
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="I01_start.html">How to start</a></li>
-<li class="toctree-l1"><a class="reference internal" href="I02_overview.html">Overview of submodules</a></li>
+<li class="toctree-l1"><a class="reference internal" href="I02_overview.html">Overview of modules</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Usage notes</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#using-mayavi-in-jupyter-notebook">Using mayavi in Jupyter notebook</a></li>
 </ul>
@@ -219,7 +219,7 @@ <h2>Using mayavi in Jupyter notebook<a class="headerlink" href="#using-mayavi-in
         <a href="base.html" class="btn btn-neutral float-right" title="Base classes (mpes.base)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
-        <a href="I02_overview.html" class="btn btn-neutral" title="Overview of submodules" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="I02_overview.html" class="btn btn-neutral" title="Overview of modules" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>
 
@@ -250,7 +250,7 @@ <h2>Using mayavi in Jupyter notebook<a class="headerlink" href="#using-mayavi-in
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.8',
+            VERSION:'1.0.9',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true,

diff --git a/docs/html/_sources/I01_start.rst.txt b/docs/html/_sources/I01_start.rst.txt
@@ -17,14 +17,22 @@ Install from git repository
 	pip install git+https://github.com/RealPolitiX/mpes.git
 
 
-Install and upgrade to the latest version
+Install and upgrade to the latest version from git repository
 
 
 .. code-block:: bash
 
 	pip install --upgrade git+https://github.com/mpes-kit/mpes.git
 
 
+Install the latest packaged version on PyPI
+
+
+.. code-block:: bash
+
+	pip install mpes
+
+
 Dependencies
 #############
 

diff --git a/docs/html/_static/documentation_options.js b/docs/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.0.8',
+    VERSION: '1.0.9',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/html/analysis.html b/docs/html/analysis.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Analysis (mpes.analysis) &mdash; mpes 1.0.8 documentation</title>
+  <title>Analysis (mpes.analysis) &mdash; mpes 1.0.9 documentation</title>
 
 
 
@@ -35,7 +35,7 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="mpes 1.0.8 documentation" href="index.html"/>
+    <link rel="top" title="mpes 1.0.9 documentation" href="index.html"/>
         <link rel="next" title="Visualization (mpes.visualization)" href="visualization.html"/>
         <link rel="prev" title="File I/O &amp; Processing (mpes.fprocessing)" href="file_io.html"/> 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                1.0.8
+                1.0.9
               </div>
 
 
@@ -92,7 +92,7 @@
 
               <ul>
 <li class="toctree-l1"><a class="reference internal" href="I01_start.html">How to start</a></li>
-<li class="toctree-l1"><a class="reference internal" href="I02_overview.html">Overview of submodules</a></li>
+<li class="toctree-l1"><a class="reference internal" href="I02_overview.html">Overview of modules</a></li>
 <li class="toctree-l1"><a class="reference internal" href="I03_usenotes.html">Usage notes</a></li>
 </ul>
 <ul class="current">
@@ -2016,7 +2016,7 @@ <h1>Analysis  <code class="docutils literal notranslate"><span class="pre">(mpes
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.8',
+            VERSION:'1.0.9',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true,

diff --git a/docs/html/base.html b/docs/html/base.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Base classes (mpes.base) &mdash; mpes 1.0.8 documentation</title>
+  <title>Base classes (mpes.base) &mdash; mpes 1.0.9 documentation</title>
 
 
 
@@ -35,7 +35,7 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="mpes 1.0.8 documentation" href="index.html"/>
+    <link rel="top" title="mpes 1.0.9 documentation" href="index.html"/>
         <link rel="next" title="File I/O &amp; Processing (mpes.fprocessing)" href="file_io.html"/>
         <link rel="prev" title="Usage notes" href="I03_usenotes.html"/> 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                1.0.8
+                1.0.9
               </div>
 
 
@@ -92,7 +92,7 @@
 
               <ul>
 <li class="toctree-l1"><a class="reference internal" href="I01_start.html">How to start</a></li>
-<li class="toctree-l1"><a class="reference internal" href="I02_overview.html">Overview of submodules</a></li>
+<li class="toctree-l1"><a class="reference internal" href="I02_overview.html">Overview of modules</a></li>
 <li class="toctree-l1"><a class="reference internal" href="I03_usenotes.html">Usage notes</a></li>
 </ul>
 <ul class="current">
@@ -597,7 +597,7 @@ <h1>Base classes  <code class="docutils literal notranslate"><span class="pre">(
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.8',
+            VERSION:'1.0.9',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true,

diff --git a/docs/html/file_io.html b/docs/html/file_io.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>File I/O &amp; Processing (mpes.fprocessing) &mdash; mpes 1.0.8 documentation</title>
+  <title>File I/O &amp; Processing (mpes.fprocessing) &mdash; mpes 1.0.9 documentation</title>
 
 
 
@@ -35,7 +35,7 @@
         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="search.html"/>
-    <link rel="top" title="mpes 1.0.8 documentation" href="index.html"/>
+    <link rel="top" title="mpes 1.0.9 documentation" href="index.html"/>
         <link rel="next" title="Analysis (mpes.analysis)" href="analysis.html"/>
         <link rel="prev" title="Base classes (mpes.base)" href="base.html"/> 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                1.0.8
+                1.0.9
               </div>
 
 
@@ -92,7 +92,7 @@
 
               <ul>
 <li class="toctree-l1"><a class="reference internal" href="I01_start.html">How to start</a></li>
-<li class="toctree-l1"><a class="reference internal" href="I02_overview.html">Overview of submodules</a></li>
+<li class="toctree-l1"><a class="reference internal" href="I02_overview.html">Overview of modules</a></li>
 <li class="toctree-l1"><a class="reference internal" href="I03_usenotes.html">Usage notes</a></li>
 </ul>
 <ul class="current">
@@ -1865,7 +1865,7 @@ <h1>File I/O &amp; Processing  <code class="docutils literal notranslate"><span
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.8',
+            VERSION:'1.0.9',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true,