Initial Tessif-PHD release

mathias-ammon · Mar 26, 2023 · 2abf516 · 2abf516
1 parent 0b6cee9
commit 2abf516
Show file tree

Hide file tree

Showing 11 changed files with 80 additions and 23 deletions.
diff --git a/README.rst b/README.rst
@@ -1,16 +1,56 @@
-TESSiF - Transforming Energy Supply System modell I ng Framework
-================================================================
+Tessif-PHD - Transforming Energy Supply System modell I ng Framework - PhD Version
+==================================================================================
 
 .. image:: https://zenodo.org/badge/618724258.svg
    :target: https://zenodo.org/badge/latestdoi/618724258
 
+Disclaimer
+----------
+Original, heavy-weight, implementation of Tessif which was published for reference and transparency reasons and to enable other researchers to reuse various aspects of its code base.
+
+A much more light-weight, application-oriented implementation can be found at: https://github.com/tZ3ma/tessif.
+
 Purpose
 -------
 Designed to provide a harmonized data input for the Energy Supply System Modelling and Optimization Software (ESSMOS) tools Calliope, FINE, oemof.solph and PyPSA.
 
-Usage
------
+Install
+-------
+
+To nstall the tessif-phd version of tessif, python 3.8 is recommend.
+After the installation, the package will be available as ``tessif``.
+
+1. Clone the git repository for **tessif-phd** 
+
+   .. code:: shell
+
+      git clone https://github.com/tZ3ma/tessif-phd.git
+    
+2. Create a new virtual environment and activate it:
+
+   .. code:: shell
+    
+      python3 -m venv your_env_name
+      source your_env_name/bin/activate
+    
+3. Make sure **pip**, **setuptools** and **wheel** are up to date:
+
+   .. code:: shell
+
+      pip install -U pip setuptools wheel
+
+
+4. Install **tessif-phd** and it's requirements:
+
+   .. code:: shell
+
+      pip install tessif-phd/
+
+
+5. After installation is done you can check if everything went according to plan by executing
+   tessif's tests. Do so by entering:
 
-Install using::
+.. code:: shell
 
-    $ pip install tessif-phd
+      python tests/nose_testing.py
+      
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -26,12 +26,12 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'Tessif-PHD - Transforming Energy Supply System Modell I ng Framework'
+project = 'Tessif-PHD - Transforming Energy Supply System Modell I ng Framework - PHD-Version'
 copyright = '2023, Mathias Ammon'
 author = 'Mathias Ammon'
 
 # The full version, including alpha/beta/rc tags
-release = '0.0.1alpha'
+release = '0.0.1'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst
@@ -4,7 +4,8 @@
 Installation
 ************
 
-Following Sections provide overview on how to install Tessif-phd.
+Following Sections provide overview on how to install the tessif-phd version of tessif.
+Python 3.8 is recommend.
 
 .. contents:: Contents
    :backlinks: top
@@ -28,7 +29,7 @@ Linux
 
    .. code:: shell
 
-      git clone https://collaborating.tuhh.de/ietma/tessif-phd/
+      git clone https://github.com/tZ3ma/tessif-phd.git
     
 5. Create a new virtual environment and activate it:
 
@@ -56,13 +57,17 @@ Linux
 
 .. code:: shell
 
-   tessif --test_install
+      python tests/nose_testing.py
        
     
 Windows
 =======
 
-Windows installation tutorial goes here
+See the development guide and replace step 9b with:
+
+   .. code:: powershell
+	     
+         pip install .
 
 
 Development
@@ -83,7 +88,7 @@ Linux
 
    .. code:: shell
 
-      git clone https://collaborating.tuhh.de/ietma/tessif-phd/
+      git clone https://github.com/tZ3ma/tessif-phd.git
     
 4. Create a new virtual environment and activate it:
 
@@ -117,7 +122,7 @@ Linux
 
    .. code:: shell
 
-      tessif --test_install
+      python tests/nose_testing.py
 
 9. (Optional) Build your own (html) documentation using Sphinx:
 
@@ -216,7 +221,7 @@ Windows
 
    .. code:: shell
 
-      git clone https://collaborating.tuhh.de/ietma/tessif-phd/
+      git clone https://github.com/tZ3ma/tessif-phd.git
     
 5. Create a new virtual environment and activate it:
 

diff --git a/setup.py b/setup.py
@@ -13,7 +13,7 @@
 
 setuptools.setup(
     name='tessif-phd',
-    version='0.0.1alpha',
+    version='0.0.1',
     description='Transforming Energy Supply System modell I ng Framework',
     long_description=long_description,
     classifiers=[
@@ -38,8 +38,20 @@
     package_dir={'': 'src'},
     package_data={
         'docs': ['*.rst'],
-        '': ['xlsx/*', 'basic/*.cfg', 'objectives/*.cfg', 'nested/*.cfg',
-             'xml/*.xml', 'hdf5/*.hdf5', 'load_profiles/*.csv'],
+        '': [
+            'xlsx/*',
+            'basic/*.cfg',
+            'objectives/*.cfg',
+            'nested/*.cfg',
+            'xml/*.xml',
+            'hdf5/*.hdf5',
+            'load_profiles/*.csv',
+            "*.txt",
+            "*.yml",
+            "*.yaml",
+            "*.csv",
+            "*.hdf5",
+        ],
     },
     py_modules=[splitext(basename(path))[0] for path in glob("src/*.py")],
     install_requires=[

diff --git a/src/tessif/examples/data/calliope/fpwe/__init__.py b/src/tessif/examples/data/calliope/fpwe/__init__.py
diff --git a/src/tessif/examples/data/calliope/fpwe/model_config/__init__.py b/src/tessif/examples/data/calliope/fpwe/model_config/__init__.py
diff --git a/src/tessif/examples/data/calliope/fpwe/timeseries_data/__init__.py b/src/tessif/examples/data/calliope/fpwe/timeseries_data/__init__.py
diff --git a/src/tessif/examples/data/calliope/mwe/model_config/__init__.py b/src/tessif/examples/data/calliope/mwe/model_config/__init__.py
diff --git a/src/tessif/examples/data/calliope/mwe/timeseries_data/__init__.py b/src/tessif/examples/data/calliope/mwe/timeseries_data/__init__.py
diff --git a/src/tessif/examples/data/calliope/timeseries_data/__init__.py b/src/tessif/examples/data/calliope/timeseries_data/__init__.py
diff --git a/src/tessif/model/energy_system.py b/src/tessif/model/energy_system.py
@@ -415,11 +415,11 @@ def connect(self, energy_system, connecting_busses, connection_uid):
             1990-07-13 03:00:00     -0.0      -84.0       -0.0      0.0    10.0       74.0
 
             >>> print(resultier.node_load['Central Bus 0'])
-            central_bus_0        connector  Excess Source 0  Power Generator 0  Renewable Source 0  Storage 0  connector  Excess Sink 0  Sink 0  Storage 0
-            1990-07-13 00:00:00      -73.0             -0.0               -0.0                -8.0       -1.0        0.0            0.0    82.0        0.0
-            1990-07-13 01:00:00      -74.0             -0.0               -0.0                -8.0       -0.0        0.0            0.0    82.0        0.0
-            1990-07-13 02:00:00      -74.0             -0.0               -0.0                -8.0       -0.0        0.0            0.0    82.0        0.0
-            1990-07-13 03:00:00      -74.0             -0.0               -0.0                -8.0       -0.0        0.0            0.0    82.0        0.0
+            Central Bus 0        Excess Source 0  Power Generator 0  Renewable Source 0  Storage 0  connector  Excess Sink 0  Sink 0  Storage 0  connector
+            1990-07-13 00:00:00             -0.0               -0.0                -8.0       -1.0      -73.0            0.0    82.0        0.0        0.0
+            1990-07-13 01:00:00             -0.0               -0.0                -8.0       -0.0      -74.0            0.0    82.0        0.0        0.0
+            1990-07-13 02:00:00             -0.0               -0.0                -8.0       -0.0      -74.0            0.0    82.0        0.0        0.0
+            1990-07-13 03:00:00             -0.0               -0.0                -8.0       -0.0      -74.0            0.0    82.0        0.0        0.0
 
             6. Plot the energy system for better understanding the defaults: