From c14f4ae0bf557721863bcaae6d34fa2933655d20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= Date: Mon, 11 Sep 2023 20:31:03 +0200 Subject: [PATCH 1/3] Fix doc still refered to create_year_index The function has been renamed some time ago. --- docs/usage.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/usage.rst b/docs/usage.rst index 32b8e3741..45a649632 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -61,7 +61,7 @@ The model time is defined by the number of intervals and the length of intervals The index will also be used for the results. For a numeric index the resulting time series will indexed with a numeric index starting with 0. One can use the function -:py:func:`~oemof.solph._energy_system/create_year_index` to create an equidistant datetime index. By default the function creates an hourly index for one year, so online the year has to be passed to the function. But it is also possible to change the length of the interval to quarter hours etc.. The default number of intervals is the number needed to cover the given year but the value can be overwritten by the user. +:py:func:`create_time_index` to create an equidistant datetime index. By default the function creates an hourly index for one year, so online the year has to be passed to the function. But it is also possible to change the length of the interval to quarter hours etc.. The default number of intervals is the number needed to cover the given year but the value can be overwritten by the user. It is also possible to define the datetime index using pandas. See `pandas date_range guide `_ for more information. @@ -69,8 +69,8 @@ Both code blocks will create an hourly datetime index for 2011: .. code-block:: python - from oemof.solph import create_year_index - my_index = create_year_index(2011) + from oemof.solph import create_time_index + my_index = create_time_index(2011) .. code-block:: python From 3167edc097bdb03954b72906ba6814a46f70365b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= Date: Mon, 11 Sep 2023 20:41:53 +0200 Subject: [PATCH 2/3] Speak of "example applications" in README The word "Examples" is used for a headine of another level in the documentation. Also, reference to the examples repository is removed as it is no longer a prefered source. --- README.rst | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 6151423e1..f13d2c535 100644 --- a/README.rst +++ b/README.rst @@ -252,19 +252,14 @@ The core ideas of oemof as a whole are described in (preprint at `arXiv:1808.0807 `_). To allow citing specific versions, we use the zenodo project to get a DOI for each version. - -.. _solph_examples_label: - -Examples -======== +Example Applications +==================== The combination of specific modules (often including other packages) is called an application (app). For example, it can depict a concrete energy system model. You can find a large variety of helpful examples in the documentation. The examples show the optimisation of different energy systems and are supposed to help new users to understand the framework's structure. -There is some elaboration on the examples in the respective repository. -The repository has sections for each major release. You are welcome to contribute your own examples via a `pull request `_ or by e-mailing us (see `here `_ for contact information). From 71c7830606c0b1fa96d87f5d5f7b0e8fcb820580 Mon Sep 17 00:00:00 2001 From: Johannes Kochems Date: Fri, 13 Oct 2023 15:09:35 +0200 Subject: [PATCH 3/3] Remove second point --- docs/usage.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage.rst b/docs/usage.rst index 45a649632..eb31df822 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -61,7 +61,7 @@ The model time is defined by the number of intervals and the length of intervals The index will also be used for the results. For a numeric index the resulting time series will indexed with a numeric index starting with 0. One can use the function -:py:func:`create_time_index` to create an equidistant datetime index. By default the function creates an hourly index for one year, so online the year has to be passed to the function. But it is also possible to change the length of the interval to quarter hours etc.. The default number of intervals is the number needed to cover the given year but the value can be overwritten by the user. +:py:func:`create_time_index` to create an equidistant datetime index. By default the function creates an hourly index for one year, so online the year has to be passed to the function. But it is also possible to change the length of the interval to quarter hours etc. The default number of intervals is the number needed to cover the given year but the value can be overwritten by the user. It is also possible to define the datetime index using pandas. See `pandas date_range guide `_ for more information.