Release of version 0.2.2

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the [project team](https://oemof.org/contact/). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1 @@
+The developer rules can be found in the chapter [developing TESPy](https://tespy.readthedocs.io/en/latest/developing_tespy.html) of the tespy.documentation.

PULL_REQUEST_TEMPLATE.md

@@ -1,13 +1,27 @@
-* Describe your pull request as transparent as possible
-  * What functionality does it implement?
-  * Where is it located?
-  * How does the API look?
-  ...
+**General**
 
-* Related issues?
+Describe your pull request as transparent as possible:
 
-* Share your knowledge: Insights/Remarks
+* What functionality does it implement?
+* Where is it located?
+* How does the API look?
+* Which bugs are fixed
+* Are there related issues?
 
-* Other comments and questions
+**Documentation**
 
-* [ ] For new features: Remember the documentation!
+Please document all changes and/or new features:
+
+* Update the API documentation
+* Update the corresponding sections in the online documentation
+* Add inline comments to your code, if required
+* Update the corresponding What's New file
+
+**Testing**
+
+* Adapt the software tests (including doc-tests), if the PR does affect existing tests
+* Add new tests for new features
+
+**Questions and Comments**
+
+You are welcome to ask for help or start a discussion on a feature. We very much appreciate your contribution.

README.rst

@@ -63,9 +63,10 @@ Examples
 
 For a short introduction on how TESPy works and how you can use it, we provide
 some
-`examples and tutorials <http://tespy.readthedocs.io/en/latest/getting_started.html>`_,
-go and check them out. You can download the python scripts of all example plants from
-the `tespy_examples <https://github.com/oemof/oemof-examples/tree/master/oemof_examples/tespy>`_
+`examples and tutorials <https://tespy.readthedocs.io/en/master/tutorials_examples.html>`_,
+go and check them out. You can download the python scripts of all example plants
+from the
+`tespy_examples <https://github.com/oemof/oemof-examples/tree/master/oemof_examples/tespy>`_
 repository.
 
 License

doc/api/modules.rst

@@ -1,6 +1,12 @@
 tespy
 =====
 
+All component and connection property equations derive from balance equations
+for fluid composition, mass flow and energy in regarding thermal as well as
+hydraulic state and thermodynamic fluid property equations respectively.
+Standard literature is for example :cite:`Baehr2016,Epple2012,Bswirth2012`
+(german). Equations and properties from other sources are cited individually.
+
 .. toctree::
    :maxdepth: 4
 

doc/api/tespy.components.rst

@@ -25,6 +25,14 @@ tespy.components.components module
     :undoc-members:
     :show-inheritance:
 
+tespy.components.customs module
+-------------------------------
+
+.. automodule:: tespy.components.customs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 tespy.components.heat_exchangers module
 ---------------------------------------
 

doc/conf.py

@@ -89,7 +89,7 @@ def plot_map(component, parameter, name, data):
     plt.close(fig)
 
 
-def generate_api_doc(component, parameter, name, char_type, rst):
+def generate_api_doc(component, parameter, name, char_type, ref):
     path = '_images/' + component + '_' + parameter + '_' + name + '.svg'
     rst = (
         '.. figure:: ' + path.replace(' ', '_') + '\n'
@@ -98,6 +98,11 @@ def generate_api_doc(component, parameter, name, char_type, rst):
         '" for parameter "' + parameter + '".\n'
         '    :align: center\n\n'
     )
+    if ref is not False:
+        rst += '    Reference: :cite:`' + ref + '`.\n\n'
+    else:
+        rst += '    Reference: Generic data.\n\n'
+
     return rst
 
 
@@ -127,7 +132,8 @@ def generate_api_doc(component, parameter, name, char_type, rst):
     for param, lines in params.items():
         for line, data in lines.items():
             plot_line(component, param, line, data)
-            rst += generate_api_doc(component, param, line, 'line', rst)
+            rst += generate_api_doc(
+                component, param, line, 'line', data['ref'])
 
 rst += (
     'Characteristic maps\n'
@@ -139,7 +145,7 @@ def generate_api_doc(component, parameter, name, char_type, rst):
     for param, chars in params.items():
         for char, data in chars.items():
             plot_map(component, param, char, data)
-            rst += generate_api_doc(component, param, char, 'map', rst)
+            rst += generate_api_doc(component, param, char, 'map', data['ref'])
 
 with open('./api/tespy.data.rst', 'w') as f:
     f.write(rst)
@@ -164,7 +170,8 @@ def generate_api_doc(component, parameter, name, char_type, rst):
     'sphinx.ext.autosummary',
     'sphinx.ext.imgmath',
     'sphinx.ext.napoleon',
-    'sphinx.ext.viewcode'
+    'sphinx.ext.viewcode',
+    'sphinxcontrib.bibtex'
 ]
 
 numpydoc_show_class_members = False

doc/index.rst

@@ -1,8 +1,3 @@
-.. TESPY documentation master file, created by
-   sphinx-quickstart on Sat Nov 18 11:20:45 2017.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to TESPy's documentation!
 =================================
 
@@ -20,6 +15,7 @@ Contents:
 	tespy_modules
 	developing_tespy
 	whats_new
+	zliterature
 	api
 
 Indices and tables
@@ -28,4 +24,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-