Skip to content

Commit

Permalink
Speak of oemof.solph in documentation
Browse files Browse the repository at this point in the history
At some locations, it's oemof-solph, because no dot is allowed.
Where it is possible, we should call the project oemof.solph.
  • Loading branch information
p-snft committed Jun 28, 2023
1 parent 3cca60b commit 1cdad7e
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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-solph 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.


::
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
contain the root `toctree` directive.
=======================================
Welcome to oemof-solph's documentation!
Welcome to oemof.solph's documentation!
=======================================

.. toctree::
Expand Down
4 changes: 2 additions & 2 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ For all parameters see the API documentation of the :py:class:`~oemof.solph.flow
solph.flows.Flow()
oemof-solph has different types of *flows* but you should be aware that you cannot connect every *flow* type with every *component*.
oemof.solph has different types of *flows* but you should be aware that you cannot connect every *flow* type with every *component*.

.. note:: See the :py:class:`~oemof.solph.flows._flow.Flow` class for all parameters and the mathematical background.

Expand Down Expand Up @@ -1004,7 +1004,7 @@ Using the multi-period (investment) mode (experimental)
Sometimes you might be interested in how energy systems could evolve in the longer-term, e.g. until 2045 or 2050 to meet some
carbon neutrality and climate protection or RES and energy efficiency targets.
While in principle, you could try to model this in oemof-solph using the standard investment mode described above (see :ref:`investment_mode_label`),
While in principle, you could try to model this in oemof.solph using the standard investment mode described above (see :ref:`investment_mode_label`),
you would make the implicit assumption that your entire system is built at the start of your optimization and doesn't change over time.
To address this shortcoming, the multi-period (investment) feature has been introduced. Be aware that it is still experimental.
So feel free to report any bugs or unexpected behaviour if you come across them.
Expand Down

0 comments on commit 1cdad7e

Please sign in to comment.