Skip to content

Commit

Permalink
Fix duplicate explicit target names
Browse files Browse the repository at this point in the history
use `name <link>`__ instead of `name <link>`_
as per sphinx-doc/sphinx#3921
  • Loading branch information
smartie2076 committed Dec 9, 2020
1 parent c87bcf6 commit c903f8e
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 55 deletions.
6 changes: 3 additions & 3 deletions docs/Developing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Contributing to MVS

Proposed workflow
-----------------
The workflow is described in the `CONTRIBUTING.md file <https://github.com/rl-institut/multi-vector-simulator/blob/dev/CONTRIBUTING.md>`_ in the repository.
The workflow is described in the `CONTRIBUTING.md file <https://github.com/rl-institut/multi-vector-simulator/blob/dev/CONTRIBUTING.md>`__ in the repository.


Unit tests (pytests)
Expand All @@ -13,7 +13,7 @@ Unit tests (pytests)
When developing code for the MVS please make sure that you always also develop test in `tests`. We integrate those unit tests with `pytest`.
Make sure that your tests are as lightweight as possible - this means that you do not always have to run the whole code to test for one feature, but can test a function with a standalone tests. Please refer to the other tests that have already been introduced.

Always aim for the test coverage button on `the main page of the github repository <https://github.com/rl-institut/multi-vector-simulator/>`_ to reach 100%!
Always aim for the test coverage button on `the main page of the github repository <https://github.com/rl-institut/multi-vector-simulator/>`__ to reach 100%!

When you do have to run the MVS itself for a test, eg. for benchmark tests, please always use the arguments `-f -log warning` to make the test results better readable.

Expand All @@ -28,7 +28,7 @@ You can build the documentation locally moving inside the `docs/` folder and typ
into a console, then go to `docs/_build/` and open `index.html` into your favorite browser.

All functions in the code will be automatically documented via their docstrings. Please make sure they follow the `Numpy format <https://numpydoc.readthedocs.io/en/latest/format.html>`_.
All functions in the code will be automatically documented via their docstrings. Please make sure they follow the `Numpy format <https://numpydoc.readthedocs.io/en/latest/format.html>`__.

Here is how to set that in pycharm

Expand Down
6 changes: 3 additions & 3 deletions docs/E-Land_Requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ They can be divided into following types:
* energy conversion
* energy storage

Details on how to model different assets are included in the model assumptions, specifically the `component models <https://mvs-eland.readthedocs.io/en/latest/Model_Assumptions.html#component-models>`_.
Details on how to model different assets are included in the model assumptions, specifically the `component models <https://mvs-eland.readthedocs.io/en/latest/Model_Assumptions.html#component-models>`__.

:ToDo: None

Expand Down Expand Up @@ -169,7 +169,7 @@ FUN-MVS-07 - Optimisation goal

In general, the MVS aims to minimize the energy supply cost of the local energy system. Additionally, following constraint can be activated:

* Minimal renewable share constraint (see `here <https://mvs-eland.readthedocs.io/en/latest/Model_Assumptions.html#minimal-renewable-share-constraint>`_)
* Minimal renewable share constraint (see `here <https://mvs-eland.readthedocs.io/en/latest/Model_Assumptions.html#minimal-renewable-share-constraint>`__)

:ToDo:

Expand All @@ -194,7 +194,7 @@ FUN-MVS-08 - Electricity cost model
The different constraints regarding the electricity DSO can be considered:

a) The energy price as well as the feed-in tariff of a DSO can be provided as a time series
b) Peak demand pricing can be considered (see `here <https://mvs-eland.readthedocs.io/en/latest/Model_Assumptions.html#peak-demand-pricing>`_)
b) Peak demand pricing can be considered (see `here <https://mvs-eland.readthedocs.io/en/latest/Model_Assumptions.html#peak-demand-pricing>`__)
c) The transformer station limitation can, but does not have to be added.

:ToDo: None
Expand Down
8 changes: 4 additions & 4 deletions docs/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
Getting started with MVS
========================

Rights: `Reiner Lemoine Institut (Berlin) <https://reiner-lemoine-institut.de/en/>`_
Rights: `Reiner Lemoine Institut (Berlin) <https://reiner-lemoine-institut.de/en/>`__

The multi-vector simulator (MVS) allows the evaluation of local sector-coupled energy systems that include the energy carriers electricity, heat and/or gas. The MVS has three main features:

Firstly, an analysis of the current energy system, which can be set up automatically from a choice of components, including its costs and performance parameters. As a second step, near-future investments into power generation and storage assets can be optimized aiming at a least-cost supply of electricity and heat. Lastly, future energy supply scenarios that integrate emerging technologies helping to meet sustainability goals and decrease adverse climate effects, e.g. through high renewable energy shares or sector-coupling technologies, can be evaluated.

The tool is being developed within the scope of the H2020 project E-LAND (Integrated multi-vector management system for Energy isLANDs, project homepage `here <https://elandh2020.eu/>`_). A graphical user interface for the MVS will be integrated.
The tool is being developed within the scope of the H2020 project E-LAND (Integrated multi-vector management system for Energy isLANDs, project homepage `here <https://elandh2020.eu/>`__). A graphical user interface for the MVS will be integrated.

**Latest release**: Check the `latest release <https://github.com/rl-institut/multi-vector-simulator/releases/tag/v0.1.1>`_, and includes the working code of the MVS using json as an input. It is not validated and test coverage is still 0%. Please check the `CHANGELOG.md <https://github.com/rl-institut/multi-vector-simulator/blob/master/CHANGELOG.md>`_ for past updates and changes.
**Latest release**: Check the `latest release <https://github.com/rl-institut/multi-vector-simulator/releases/tag/v0.1.1>`__, and includes the working code of the MVS using json as an input. It is not validated and test coverage is still 0%. Please check the `CHANGELOG.md <https://github.com/rl-institut/multi-vector-simulator/blob/master/CHANGELOG.md>`__ for past updates and changes.

**Upcoming**: As the MVS is still under development, many changes will still occur in the code as well as code structure. If you want to try the MVS, please make sure to check this project regularly.

Expand Down Expand Up @@ -175,4 +175,4 @@ Contributing and additional information for developers

If you want to contribute to this project, please read [CONTRIBUTING.md](https://github.com/rl-institut/multi-vector-simulator/blob/dev/CONTRIBUTING.md). For less experienced github users we propose a workflow. [Link](https://github.com/rl-institut/multi-vector-simulator/wiki/Examplary-Workflow).

For advanced programmers: You can also use the dev version that includes the latest updates and changes, but which in turn might not be tested. You can find the CHANGELOG.md on this`page <https://github.com/rl-institut/multi-vector-simulator/blob/dev/CHANGELOG.md>`_.
For advanced programmers: You can also use the dev version that includes the latest updates and changes, but which in turn might not be tested. You can find the CHANGELOG.md on this`page <https://github.com/rl-institut/multi-vector-simulator/blob/dev/CHANGELOG.md>`__.
8 changes: 4 additions & 4 deletions docs/MVS_Outputs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ Onsite energy fraction (OEF)

Onsite energy fraction is also referred to as self-consumption. It describes
the fraction of all locally generated energy that is consumed by the system
itself. (see `[1] <https://www.sciencedirect.com/science/article/pii/S0960148119315216>`_ and `[2] <https://www.iip.kit.edu/downloads/McKennaetal_paper_full.pdf>`_).
itself. (see `[1] <https://www.sciencedirect.com/science/article/pii/S0960148119315216>`__ and `[2] <https://www.iip.kit.edu/downloads/McKennaetal_paper_full.pdf>`__).

An OEF close to zero shows that only a very small amount of locally generated
energy is consumed by the system itself. It is at the same time an indicator
Expand All @@ -242,7 +242,7 @@ Onsite energy matching (OEM)
The onsite energy matching is also referred to as "self-sufficiency". It
describes the fraction of the total demand that can be
covered by the locally generated energy (see
`[1] <https://www.sciencedirect.com/science/article/pii/S0960148119315216>`_ and `[2] <https://www.iip.kit.edu/downloads/McKennaetal_paper_full.pdf>`_).
`[1] <https://www.sciencedirect.com/science/article/pii/S0960148119315216>`__ and `[2] <https://www.iip.kit.edu/downloads/McKennaetal_paper_full.pdf>`__).
Notice that the feed into the grid should only be positive.

An OEM close to zero shows that very little of the demand can be covered by
Expand All @@ -262,7 +262,7 @@ Degree of autonomy (DA)
#######################

The degree of autonomy describes the relation of the total locally
generated energy to the total demand of the system (see `[2] <https://www.iip.kit.edu/downloads/McKennaetal_paper_full.pdf>`_).
generated energy to the total demand of the system (see `[2] <https://www.iip.kit.edu/downloads/McKennaetal_paper_full.pdf>`__).

A DA close to zero shows high dependence on the DSO,
while a DA of 1 represents an autonomous or net-energy system
Expand All @@ -282,6 +282,6 @@ MVS version number, the branch ID and the simulation date are provided as well i
A commit hash number is provided at the end of the report in order to prevent the erroneous comparing results from simulations using different versions.

It includes several tables with project data, simulation settings, the various demands supplied by the user, the various components of the system and the optimization results such as the energy flows and the costs.
The report also provides several plots which help to visualize the flows and costs. The PDF report can be generated by running the command (details in the READTHEDOCS `here <https://github.com/rl-institut/multi-vector-simulator/blob/dev/README.md#generate-report>`_)::
The report also provides several plots which help to visualize the flows and costs. The PDF report can be generated by running the command (details in the READTHEDOCS `here <https://github.com/rl-institut/multi-vector-simulator/blob/dev/README.md#generate-report>`__)::

python mvs_report.py
Loading

0 comments on commit c903f8e

Please sign in to comment.