Documentation and dict functions

README.rst

@@ -6,7 +6,7 @@ Universal File Format read and write
 This module is part of the www.openmodal.com project and defines an UFF class
 to manipulate with the UFF (Universal File Format) files.
 
-Read from and write of data-set types **151, 15, 55, 58, 58b, 82, 164, 2411, 2412, 2420** are supported.
+Read from and write of data-set types **15, 55, 58, 58b, 82, 151, 164, 2411, 2412, 2414, 2420** are supported.
 
 Note: this project is developed and tested for Python 3, only.
 

dict_test.ipynb

@@ -0,0 +1,40 @@
+{
+ "metadata": {
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.8.3"
+  },
+  "orig_nbformat": 2,
+  "kernelspec": {
+   "name": "python3",
+   "display_name": "Python 3.8.3 64-bit ('base': conda)",
+   "metadata": {
+    "interpreter": {
+     "hash": "e04390b745d7540077d5afc7ea9b350ff3db0922faee759c3145cf85f5ee4c0c"
+    }
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2,
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import sys\n",
+    "sys.path.insert(0, './')"
+   ]
+  }
+ ]
+}

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/source/Supported_datasets.rst

@@ -0,0 +1,100 @@
+Supported datasets
+==================
+
+More info on specific datasets can be obtained `here <https://www.ceas3.uc.edu/sdrluff>`_
+
+
+Dict function showcase
+-----------------------
+
+Dict functions are used for generating dictionary like keys cointaining measurement data and the information about the mesurement. 
+
+Parameter ``return_full_dict`` determines if all keys or only specified arguments are returned.
+
+.. code:: python
+
+    import pyuff
+
+    pyuff.dict_151(model_name='NewModel',date_db_created='17-Jun-21',time_db_created= '12:49:33',version_db1= 0, version_db2= 0,file_type= 0)
+
+
+
+
+
+
+
+
+Dataset 15
+----------
+
+.. autofunction:: pyuff.dict_15
+
+
+Dataset 55
+----------
+
+.. autofunction:: pyuff.dict_55
+
+
+Dataset 58<b>
+-------------
+
+.. autofunction:: pyuff.dict_58
+
+
+Dataset 82
+----------
+
+.. autofunction:: pyuff.dict_82
+
+
+Dataset 151
+-----------
+
+.. autofunction:: pyuff.dict_151
+
+Dataset 164
+-----------
+
+.. autofunction:: pyuff.dict_164
+
+
+Dataset 2411
+-------------
+
+.. autofunction:: pyuff.dict_2411
+
+
+Dataset 2412
+-------------
+
+.. autofunction:: pyuff.dict_2412
+
+
+Dataset 2414
+-------------
+
+.. autofunction:: pyuff.dict_2414
+
+
+Dataset 2420
+-------------
+
+.. autofunction:: pyuff.dict_2420
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

docs/source/code_documentation.rst

@@ -0,0 +1,8 @@
+Code documentation
+==================
+
+The ``UFF`` class
+-------------------
+
+
+.. autoclass:: pyuff.UFF