Proofread RTD Getting started and landing page#871
Conversation
|
Ah, did you not plan to create one changelog entry, in which we can list the RTD PR step by step? |
Yes but I am not done with the .rst file/this PR yet, I still have to go through the chapter Defining an energy system |
Ah, okay, I didnt see that it was a draft. Let me know when I should do the next review! |
Bachibouzouk
force-pushed
the
fix/proof-RTD-intro
branch
from
b70c9a3 to
9488123
Compare
smartie2076
left a comment
smartie2076
left a comment
There was a problem hiding this comment.
Nice! There are two issues where we need to check if a advertized function really works/does not work.
I am not sure how we want to deal with this - maybe if you find an issue remove the connected line, paste it into the existing issue with a line number, so that it can be changed when the issue is being solved.
If no issue exists (and a smoke test shows it does not work, or if the test should be implemented as a pytest), an issue can be created. We then use the wording that is more careful, and place the text of the advertized feature into the new issue.
| @@ -0,0 +1,6 @@ | |||
| .. _benchmarks_examples: | |||
There was a problem hiding this comment.
Is the plan to have more examples here, or to expand the examples?
There was a problem hiding this comment.
We can either have a section with multiple small examples here or just this one example detailed, then link to the input files of the other examples. I think the former is preferable, because we will never have time to draft a nice step by step description of all benchmark tests
docs/simulating_with_the_mvs.rst
Outdated
| | └── mvs_config.json | ||
|
|
||
|
|
||
| The name and location of the :code:`input_folder` is up to the user. The underlying structure and file names within this folder should not be altered. |
There was a problem hiding this comment.
Exept for the file storage_01.csv which can have a freely defined name referenced in energyStorages.csv.
| Time series: time_series folder | ||
| ############################### | ||
| Some parameters value in the CSV/Json files are filenames. Those filenames correspond to files which must be present in the folder :code:`time_series` in your input folder, formatted as CSV. | ||
| As an example, if one asset listed in :ref:`energy production <production>` has :code:`generation_pv.csv` as value for the :ref:`file_name <filename-label>`. The file :code:`generation_pv.csv` containing a value of the pv generation for each timestep of the simulation should be present in the :code:`time_series` folder. |
There was a problem hiding this comment.
| As an example, if one asset listed in :ref:`energy production <production>` has :code:`generation_pv.csv` as value for the :ref:`file_name <filename-label>`. The file :code:`generation_pv.csv` containing a value of the pv generation for each timestep of the simulation should be present in the :code:`time_series` folder. | |
| As an example, if one asset listed in :ref:`energy production <production>` has :code:`generation_pv.csv` as value for the :ref:`file_name <filename-label>`. The file :code:`generation_pv.csv` (containing a value of the pv generation for each timestep of the simulation) should be present in the :code:`time_series` folder. |
Old:
As an example, if one asset listed in :ref:`energy production <production>` has :code:`generation_pv.csv` as value for the :ref:`file_name <filename-label>`. This file :code:`generation_pv.csv` contains the specific pv generation for each timestep of the simulation and should be present in the :code:`time_series` folder.
There was a problem hiding this comment.
You suggestion changes the main verb of the sentence which is "the file should be present", I will therefore not add it
There was a problem hiding this comment.
Then how about brackets?
|
I wanted to ask you to have a look at the "Building a model from assets and energy flows" section @smartie2076 as I am not sure it is up to date or if it doesn't require a good restructuring, as I am not sure the text would be helpful to anyone in its current form. Who was the target audience you wrote it for? Shouldn't we have a section titled "Energy system network"? |
Bachibouzouk
force-pushed
the
fix/proof-RTD-intro
branch
from
c38a881 to
faae619
Compare
Add links to projects and git repos Reordered content Removed superfluous information
Co-authored-by: smartie2076 <[email protected]>
Co-authored-by: smartie2076 <[email protected]>
Bachibouzouk
force-pushed
the
fix/proof-RTD-intro
branch
from
faae619 to
5a91d6c
Compare
Sure, I will have a look. I did write it for the end users, ie. project location owners initially... |
2 participants
Changes proposed in this pull request:
The following steps were realized, as well (if applies):
For more information on how to contribute check the CONTRIBUTING.md.