Merge branch 'dev' into revision/rename_transformer_to_converter

# Conflicts: # docs/reference/oemof.solph.components.rst # docs/whatsnew/v0-5-1.rst # src/oemof/solph/components/__init__.py # src/oemof/solph/components/_converter.py # src/oemof/solph/components/_offset_converter.py # src/oemof/solph/components/experimental/__init__.py # src/oemof/solph/components/experimental/_piecewise_linear_converter.py # tests/constraint_tests.py # tests/lp_files/converter.lp # tests/lp_files/converter_invest.lp # tests/lp_files/converter_invest_with_existing.lp # tests/lp_files/flow_nonconvex_invest_bounded_transformer.lp # tests/lp_files/linear_converter.lp # tests/lp_files/linear_converter_chp.lp # tests/lp_files/linear_converter_chp_invest.lp # tests/lp_files/linear_converter_invest.lp # tests/lp_files/nonequidistant_timeindex.lp # tests/lp_files/offsettransformer.lp # tests/lp_files/piecewise_linear_transformer_cc.lp # tests/lp_files/piecewise_linear_transformer_dcc.lp # tests/test_scripts/test_solph/test_storage_investment/test_storage_investment.py
oemof · Aug 9, 2023 · 61a295a · 61a295a
2 parents 9ee2d90 + b324061
commit 61a295a
Show file tree

Hide file tree

Showing 217 changed files with 34,517 additions and 5,689 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.5.1.dev0
+current_version = 0.5.1.dev3
 commit = True
 tag = True
 

diff --git a/.cookiecutterrc b/.cookiecutterrc
@@ -63,7 +63,7 @@ default_context:
     test_runner:               'pytest'
     travis:                    'yes'
     travis_osx:                'yes'
-    version:                   '0.4.0.dev0'
+    version:                   '0.4.0.dev1'
     website:                   'https://oemof.org'
     year_from:                 '2014'
     year_to:                   '2020'
diff --git a/.gitignore b/.gitignore
@@ -44,6 +44,7 @@ htmlcov
 .project
 .pydevproject
 .idea
+.vscode
 *.iml
 *.komodoproject
 

diff --git a/.readthedocs.yml → .readthedocs.yaml b/.readthedocs.yml → .readthedocs.yaml
@@ -5,7 +5,7 @@ build:
     - coinor-cbc
 sphinx:
   configuration: docs/conf.py
-formats: all
+formats: []
 python:
   version: "3.8"
   install:

diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -28,6 +28,7 @@ Authors
 * Jonathan Amme
 * Julian Endres
 * Lluis Millet
+* Lennart Schürmann
 * Martin Soethe
 * Patrik Schönfeldt
 * Pierre-François Duc
@@ -36,3 +37,4 @@ Authors
 * Simon Hilpert
 * Stephan Günther
 * Uwe Krien
+* Tobi Rohrer
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
diff --git a/CITATION.cff b/CITATION.cff
@@ -103,41 +103,63 @@ authors:
     given-names: Bryan
     alias: "@bmlancien"
   -
+    family-names: Developer
+    given-names: Anonymous
     alias: "@nesnoj"
   -
+    family-names: Developer
+    given-names: Anonymous
     alias: "@lmilletb"
   -
+    family-names: Developer
+    given-names: Anonymous
     alias: "@mloenneberga"
   -
     family-names: "Schürmann"
     given-names: Lennart
     alias: "@lensum"
   -
+    family-names: Developer
+    given-names: Anonymous
     alias: "@RD-OTH"
   -
     family-names: Delfs
     given-names: Jens-Olaf
     alias: "@drjod"
   -
+    family-names: Developer
+    given-names: Anonymous
     alias: "@stefansc1"
   -
+    family-names: Developer
+    given-names: Anonymous
     alias: "@escalacjo"
   -
     family-names: Smalla
     given-names: Tjark
     alias: "@ChillkroeteTTS"
   -
+    family-names: Developer
+    given-names: Anonymous
     alias: "@ajimenezUCLA"
   -
     family-names: Wolf
     given-names: Jakob
     alias: "@jakob-wo"
   -
+    family-names: Developer
+    given-names: Anonymous
     alias: "@elisapap"
   -
     family-names: Gaudchau
     given-names: Elisa
     alias: "@elisagaudchau"
   -
+    family-names: Developer
+    given-names: Anonymous
     alias: "@chrisflei"
+  -
+    family-names: Rohrer
+    given-names: Tobi
+    alias: "@tobirohrer"
 ...
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -72,11 +72,11 @@ For merging, you should:
 
 1. Include passing tests (run ``tox``) [1]_.
 2. Update documentation when there's new API, functionality etc.
-3. Add a note to ``CHANGELOG.rst`` about the changes.
-4. Add yourself to ``AUTHORS.rst`` and ``CITATION.cff``.
+3. Add a note about the changes to ``docs/whatsnew/next_version.rst``.
+4. Add your name to ``AUTHORS.rst`` and ``CITATION.cff``.
 
-.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
-       `run the tests <https://travis-ci.org/oemof/oemof-solph/pull_requests>`_ for each change you add in the pull request.
+.. [1] If you don't have all the necessary python versions available locally,
+       you can rely on the CI pipeline at GitHub.
 
        It will be slower though ...
 

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2022, oemof developer group
+Copyright (c) 2014-2023, oemof developer group
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -20,6 +20,7 @@ include pytest.ini
 
 include tox.ini
 include *.yml
+include *.yaml
 
 recursive-exclude examples *.py
 recursive-include examples *.csv

diff --git a/README.rst b/README.rst
@@ -115,10 +115,10 @@ Read our `contribution <https://oemof.readthedocs.io/en/latest/contributing.html
 
 Contribution is already possible on a low level by simply fixing typos in
 oemof's documentation or rephrasing sections which are unclear.
-If you want to support us that way please fork the oemof repository to your own
+If you want to support us that way please fork the oemof-solph repository to your own
 github account and make changes as described in the `github guidelines <https://docs.github.com/en/get-started/quickstart/hello-world>`_
 
-If you have questions regarding the use of oemof you can visit the forum at `openmod-initiative.org <https://forum.openmod-initiative.org/tags/c/qa/oemof>`_ and open a new thread if your questions hasn't been already answered.
+If you have questions regarding the use of oemof including oemof.solph you can visit the openmod forum (`tag oemof <https://forum.openmod-initiative.org/tags/c/qa/oemof>`_ or `tag oemof-solph <https://forum.openmod-initiative.org/tags/c/qa/oemof-solph>`_) and open a new thread if your questions hasn't been already answered.
 
 Keep in touch! - You can become a watcher at our `github site <https://github.com/oemof/oemof>`_,
 but this will bring you quite a few mails and might be more interesting for developers.
@@ -135,7 +135,7 @@ The `oemof.solph documentation <https://oemof-solph.readthedocs.io/>`_ is powere
 Installation
 ============
 
-If you have a working Python3 environment, use pypi to install the latest oemof version. Python >= 3.6 is recommended. Lower versions may work but are not tested.
+If you have a working Python3 environment, use pypi to install the latest version of oemof.solph. Python >= 3.8 is recommended. Lower versions may work but are not tested.
 
 
 ::
@@ -170,7 +170,7 @@ To install the solvers have a look at the package repository of your Linux distr
 
 **Windows**
 
- 1. Download CBC (`64 <https://ampl.com/dl/open/cbc/cbc-win64.zip>`_ or `32 <https://ampl.com/dl/open/cbc/cbc-win32.zip>`_ bit)
+ 1. Download `CBC <https://github.com/coin-or/Cbc/releases>`_
  2. Download `GLPK (64/32 bit) <https://sourceforge.net/projects/winglpk/>`_
  3. Unpack CBC/GLPK to any folder (e.g. C:/Users/Somebody/my_programs)
  4. Add the path of the executable files of both solvers to the PATH variable using `this tutorial <https://www.computerhope.com/issues/ch000549.htm>`_
@@ -266,7 +266,7 @@ You are welcome to contribute your own examples via a `pull request <https://git
 License
 =======
 
-Copyright (c) 2022 oemof developer group
+Copyright (c) 2023 oemof developer group
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-__version__ = "0.5.1.dev0"
+__version__ = "0.5.1.dev3"
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -9,6 +9,7 @@ These are new features and improvements of note in each release
     :backlinks: top
 
 
+.. include::  whatsnew/v0-5-0.rst
 .. include::  whatsnew/v0-4-5.rst
 .. include::  whatsnew/v0-4-4.rst
 .. include::  whatsnew/v0-4-2.rst

diff --git a/docs/conf.py b/docs/conf.py
@@ -31,10 +31,10 @@ def setup(app):
 source_suffix = ".rst"
 master_doc = "index"
 project = "oemof.solph"
-year = "2014-2022"
+year = "2014-2023"
 author = "oemof-developer-group"
 copyright = "{0}, {1}".format(year, author)
-version = release = "0.5.1.dev0"
+version = release = "0.5.1.dev3"
 
 pygments_style = "trac"
 templates_path = ["."]

diff --git a/docs/examples/solph.examples.rst b/docs/examples/solph.examples.rst
@@ -22,6 +22,12 @@ Balanced and unbalanced storage
 .. automodule:: storage_balanced_unbalanced.storage
 
 
+Cellular modelling
+------------------
+
+.. automodule:: cellular.cellular
+
+
 Electrical
 ----------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,9 +3,9 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-=================================
-Welcome to oemof's documentation!
-=================================
+=======================================
+Welcome to oemof.solph's documentation!
+=======================================
 
 .. toctree::
    :maxdepth: 3

diff --git a/docs/reference/oemof.solph.components.rst b/docs/reference/oemof.solph.components.rst
@@ -57,6 +57,14 @@ OffsetConverter
     :undoc-members:
     :show-inheritance:
 
+Link
+----
+
+.. automodule:: oemof.solph.components._link
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 experimental.ElectricalLine
 ---------------------------
 
@@ -73,17 +81,8 @@ experimental.GenericCAES
     :undoc-members:
     :show-inheritance:
 
-experimental.Link
------------------
-
-.. automodule:: oemof.solph.components.experimental._link
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 experimental.PiecewiseLinearConverter
 -------------------------------------
-
 .. automodule:: oemof.solph.components.experimental._piecewise_linear_converter
     :members:
     :undoc-members:

diff --git a/docs/reference/oemof.solph.constraints.rst b/docs/reference/oemof.solph.constraints.rst
@@ -2,6 +2,6 @@ oemof.solph.constraints
 -----------------------
 
 .. automodule:: oemof.solph.constraints
-    :members: equate_variables, equate_flows, limit_active_flow_count, limit_active_flow_count_by_keyword, emission_limit, generic_integral_limit, additional_investment_flow_limit, investment_limit, shared_limit
+    :members: equate_variables, equate_flows, limit_active_flow_count, limit_active_flow_count_by_keyword, emission_limit, generic_integral_limit, additional_investment_flow_limit, investment_limit, shared_limit, storage_level_constraint
     :undoc-members:
     :show-inheritance:
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,3 +2,11 @@ sphinx>=1.3
 sphinx-rtd-theme
 setuptools
 matplotlib
+blinker
+dill
+numpy
+pandas >= 1.5.3
+pyomo >= 6.6.0, < 7.0
+networkx
+oemof.tools >= 0.4.2
+oemof.network >= 0.5.0a1