Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs #169

Merged
merged 17 commits into from
Oct 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ oemof.solph. Currently, most of the functions collected here are intended to be
together with oemof.solph. However, in some instances they may be useful independently
of oemof.solph.

oemof.thermal is rather new and under active development. Contributions are welcome.
oemof.thermal is under active development. Contributions are welcome.

Quickstart
==========
Expand Down Expand Up @@ -48,9 +48,8 @@ Find the documentation at `<https://oemof-thermal.readthedocs.io>`_.
Contributing
============

Everybody is welcome to contribute to the development of oemof.thermal. The `developer
guidelines of oemof <https://oemof.readthedocs.io/en/stable/developing_oemof.html>`_
are in most parts equally applicable to oemof.thermal.
Everybody is welcome to contribute to the development of oemof.thermal. Find here the `developer
guidelines of oemof <https://oemof.readthedocs.io/en/latest/developing_oemof.html>`_.

License
=======
Expand Down
2 changes: 1 addition & 1 deletion docs/absorption_chillers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@


~~~~~~~~~~~~~~~~~~~~~~~
Absorption chillers
Absorption chiller
~~~~~~~~~~~~~~~~~~~~~~~

Calculations for absorption chillers based on the characteristic equation method.
Expand Down
4 changes: 2 additions & 2 deletions docs/compression_heat_pumps_and_chillers.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _compression_heat_pumps_label:

Compression Heat Pumps and Chillers
===================================
Compression heat pump and chiller
=================================

Simple calculations for compression heat pumps and chillers.

Expand Down
6 changes: 3 additions & 3 deletions docs/concentrating_solar_power.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ part of the absorbed heat output through thermal losses
(:math:`\dot Q_{loss,therm}`).


The processing of the irradiance data is done by the pvlib, which calculates
The processing of the irradiance data is done by the `pvlib <https://github.com/pvlib/pvlib-python>`_, which calculates
the direct irradiance on the collector. This irradiance is reduced by dust and
dirt on the collector with:

Expand Down Expand Up @@ -199,10 +199,10 @@ instead of separate source and transformer.
.. code-block:: python

from oemof import solph
>>> from oemof.thermal.facades import Collector
>>> from oemof.thermal.facades import ParabolicTroughCollector
>>> bth = solph.Bus(label='thermal_bus')
>>> bel = solph.Bus(label='electrical_bus')
>>> collector = Collector(
>>> collector = ParabolicTroughCollector(
... label='solar_collector',
... heat_bus=bth,
... electrical_bus=bel,
Expand Down
5 changes: 4 additions & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ references to the literature are listed that the reader can refer to if she want
information on the background.

Finally, there are a couple of examples that can give an idea of how the functionality of
oemof.thermal can be utilized.
oemof.thermal can be utilized. Some models have undergone validation whose results you'll find
in the section "Model validation".

.. contents:: `Contents`
:depth: 1
Expand Down Expand Up @@ -74,6 +75,8 @@ Examples
--------

We provide examples described in the section :ref:`examples_label`.
Further we developed some complex models with the oemof-thermal components
which are described in this section as well.


Contributing to oemof.thermal
Expand Down
18 changes: 9 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,7 @@ Welcome to oemof.thermal's documentation!
getting_started
examples

.. toctree::
:maxdepth: 1
:caption: Model validation

validation_compression_heat_pumps_and_chillers
validation_concentrating_solar_power
validation_solar_thermal_collector
validation_stratified_thermal_storage


.. toctree::
:maxdepth: 1
:caption: User's guide
Expand All @@ -35,6 +27,14 @@ Welcome to oemof.thermal's documentation!
solar_thermal_collector
stratified_thermal_storage


.. toctree::
:maxdepth: 1
:caption: Model validation

validation_compression_heat_pumps_and_chillers
validation_stratified_thermal_storage


.. toctree::
:maxdepth: 1
Expand Down
7 changes: 3 additions & 4 deletions docs/solar_thermal_collector.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Scope
_____

This module was developed to provide the heat of a flat plate collector
based on temperatures and collectors location, tilt and azimuth for energy
based on temperatures and collector's location, tilt and azimuth for energy
systems optimizations with oemof.solph.

In
Expand All @@ -20,7 +20,7 @@ with flat plate collector, storage and backup to provide a given heat demand.
The time series of the pre-calculated heat is output of a source (an oemof.solph
component) representing the collector, and a transformer (an oemof.solph component)
is used to hold electrical power consumption and further thermal losses of the
collector in an energy system optimization. In addition, you will find an plot,
collector in an energy system optimization. In addition, you will find a plot,
which compares this precalculation with a calculation with a constant efficiency.

Concept
Expand All @@ -37,7 +37,7 @@ the collector and the location. The following scheme shows the calculation proce

Fig.1: The energy flows and losses at a flat plate collector.

The processing of the irradiance data is done by the pvlib, which calculates the total
The processing of the irradiance data is done by the `pvlib <https://github.com/pvlib/pvlib-python>`_, which calculates the total
in-plane irradiance according to the azimuth and tilt angle of the collector.

The efficiency of the collector is calculated with
Expand Down Expand Up @@ -185,4 +185,3 @@ instead of separate source and transformer.
irradiance_diffuse=input_data['diffuse_horizontal_W_m2'],
temp_amb_col=input_data['temp_amb'],
)

10 changes: 6 additions & 4 deletions docs/validation_stratified_thermal_storage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Scope
_____

The validation of the stratified thermal storage has been conducted within
the `oemof_heat <https://github.com/oemof-thermal>`_ project.
the `oemof_heat <https://github.com/oemof-heat>`_ project.
Measurement data of a reference storage has been provided by the energy supplier Naturstrom AG.
The set of data contains the storage geometry (height, diameter, insulation thickness),
temperatures at top and bottom of the storage and a time series of the storage level.
Expand Down Expand Up @@ -44,6 +44,7 @@ For some parameters assumptions had to be made.
heat transfer coef. inside 7 W/(m2*K)
heat transfer coef. outside 4 W/(m2*K)
================================ =============================

Tab.1: Input parameters used for the model validation

Please see the
Expand All @@ -63,7 +64,7 @@ where :math:`T_\mathrm{mean}` is the arithmetic mean temperature of the storage.
where :math:`n` is the amount of temperature sensors.

Measurement data
_______
________________

The measurement data come from an energy system that contains several identical storages.
Here, only a single storage is calculated to keep the model simple.
Expand Down Expand Up @@ -101,6 +102,7 @@ Time Level in %
5.25 76.54
5.5 76.33
======= ==============

Tab.2: Measured storage level.

Results
Expand All @@ -126,8 +128,8 @@ fluctuating level signal.
Fig.1: Measured storage level (red) and calculated storage level (blue).


The model allows an approximation of the losses in periods without
charging or discharging from simple storage geometry data.
The model allows an approximation of the losses from simple storage geometry data
in periods without charging or discharging.

You can reproduce Fig.1 and the calculation with the example ``model_validation.py``
in the `examples section <https://github.com/oemof/oemof-thermal/tree/dev/examples/stratified_thermal_storage>`_
Expand Down