tomato release 0.2 PR (#50)

* Add version docs etc. * Remove [samples] from settings file.
dgbowl · Oct 6, 2022 · 7214763 · 7214763
1 parent 5673145
commit 7214763
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 9 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,12 +1,19 @@
 **tomato**: au-tomation without the pain!
 =========================================
+.. image:: https://badgen.net/badge/docs/dgbowl.github.io/grey?icon=firefox
+   :target: https://dgbowl.github.io/tomato
+.. image:: https://badgen.net/pypi/v/tomato/?icon=pypi
+   :target: https://pypi.org/project/tomato
+.. image:: https://badgen.net/github/tag/dgbowl/tomato/?icon=github
+   :target: https://github.com/dgbowl/tomato
 
 **tomato** is an instrument automation package, currently developed in the 
 `Materials for Energy Conversion <https://www.empa.ch/web/s501>`_ lab at Empa. 
 
 **tomato** includes:
 
-- the job scheduler and queue, :mod:`tomato.daemon`, using a ``sqlite3`` backend for IPC;
+- the job scheduler and queue, :mod:`tomato.daemon`, using a ``sqlite3`` as a 
+  backend for IPC;
 - the configuration utility :mod:`~tomato.ketchup`, modelled after PBS / SGE; 
 - a set of device drivers, see the :ref:`driver library`.
 
@@ -21,6 +28,7 @@
    installation
    quickstart
    usage
+   version
 
 .. _driver library:
 

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -17,11 +17,6 @@ environment.
     The optional targets ``[docs]`` and ``[testing]`` will install packages required 
     for building this documentation and running the test-suite, respectively.
 
-.. note::
-
-    As currently **tomato** does not have a stable release, make sure to install 
-    the latest development version using the ``--pre`` argument to ``pip``.
-
 Testing the installation
 ````````````````````````
 To run the test-suite, you need to first install **tomato** using the above command,

diff --git a/docs/source/version.rst b/docs/source/version.rst
@@ -0,0 +1,23 @@
+**tomato**-v0.2
+---------------
+.. image:: https://img.shields.io/static/v1?label=tomato&message=v0.2&color=blue&logo=github
+    :target: https://github.com/dgbowl/tomato/tree/0.2
+.. image:: https://img.shields.io/static/v1?label=tomato&message=v0.2&color=blue&logo=pypi
+    :target: https://pypi.org/project/tomato/0.2/
+.. image:: https://img.shields.io/static/v1?label=release%20date&message=2022-10-06&color=red&logo=pypi
+
+.. sectionauthor::
+    Peter Kraus
+
+Developed in the Materials for Energy Conversion lab at Empa, in Dübendorf, with
+contributions from the THEOS lab at EPFL, in Lausanne.
+
+First public release, corresponding to the code developed for the BIG-MAP Stakeholder
+Initiative Aurora, Deliverable D2. 
+
+- support for :class:`pd.MultiIndex` in :class:`pd.DataFrames`;
+- the :mod:`~dgpost.transform.table` module of functions for basic operations on tables.
+
+.. codeauthor::
+    Peter Kraus,
+    Loris Ercole.
diff --git a/src/tomato/setlib/functions.py b/src/tomato/setlib/functions.py
@@ -52,9 +52,6 @@ def get_settings(configpath: str, datapath: str) -> dict:
             type = 'sqlite3'
             path = '{os.path.join(datapath, 'database.db')}'
             storage = '{os.path.join(datapath, 'Jobs')}'
-            
-            [samples]
-            path = '{os.path.join(configpath, 'samples.yml')}'
 
             [devices]
             path = '{os.path.join(configpath, 'devices.yml')}'