Review of the documentation #105

c-moeller · 2023-06-15T13:40:40Z

No description provided.

Setup auto-build RTD

Add documentation content

Spelling mistake corrected

…ch-2 Update index.rst

Enable pdf build

docs/model/parameters/MVS_parameters_categories.inc

docs/getting_started/quick_start_guide.rst

a-linke · 2023-06-21T12:27:43Z

docs/getting_started/quick_start_guide.rst

+
+
+Before proceeding to the next section, be sure to complete the information requirements for each component and save the energy system.
+


Here I am missing a general word that for specific components as e.g. PV you need an input timeseries. Additional a link to renewables.ninja or something similar would be great as well as that you want to include it in kWp and for example not the solar irradiation values itself, right?

I agree with you this information lacks

a-linke · 2023-06-21T14:21:32Z

docs/images/IMG_example_storage.png

In the latest version already online here https://open-plan.rl-institut.de ? Because I cant chose a hydrogen storage to my system

a-linke · 2023-06-21T14:40:05Z

docs/model/assumptions.rst

+The equation is the following:
+
+.. math::
+        min Z = \sum_i a_i \cdot CAP_i + \sum_i \sum_t c_{var,i} \cdot E_i(t)


would be great if all the equations are shown in nice formatting, now it is shown in code-writing

The nice formatting you get it in the compiled read the docs: https://open-plan-documentation--105.org.readthedocs.build/en/105/ (at the bottom of the PR, click on show checks, then on "Details")

unfortunately not :( see screenshot

ok, this is fixable in the RTD settings, I will look into it next week, unless it is urgent?

@Bachibouzouk please check before merging if this has been fixed

On my local RTD build of the dev branch, I see the equations correctly, I will make sure we see them online

a-linke · 2023-06-21T15:01:33Z

docs/getting_started/quick_start_guide.rst

+The components representing battery energy storage systems (BESS) have been defined with one input and one output. The BESS can be connected directly to the electrical bus; please note that the bus is supplied and feeds the battery at the same time.
+.. image:: ../images/IMG_example_storage.png
+ :width: 100%
+


image not shown, only code to include it

@NargesChinichian Please check why this image is not implemented

I think it just needed a break line. Should be fixed now.

Hi @NargesChinichian did you fix it somewhere? I don't see it. I will insert a break line. You can reject the suggestion if you have fixed it already somewhere else.

a-linke · 2023-06-21T15:11:58Z

docs/model/parameters/.gitkeep

I am missing the input parameters section in the table of contents

This is because it comes from the MVS documentation. @NargesChinichian can you create a link in the table of contents under Model Reference?

@c-moeller I'm not exactly sure what you mean. Do you mean the table of content on the left side of the main doc page? The parameters we have in the folder are not the correct parameters, we should first have those files updated and then add a link [if I understood Avia's comment correctly].

I did not fully remove the "parameters" folder because I thought it's a good structure if we later wanted to add some.

I meant this page: https://open-plan-documentation.readthedocs.io/en/latest/model/input_parameters.html which comes from the MVS documentation but we could also link to in our table of contents (left side of the doc page). But you are right, these are not exactly the ones we use.

What do you mean with "parameters" folder?

a-linke · 2023-06-21T15:14:26Z

docs/model/parameters/.gitkeep

another nice-to-have would be for each input parameter to which components/project stages (e.g. scenario description) it can be applied (e.g. state-of-charge only for battery storage systems, investment cost for all of the components as well as the whole project)

this is possible with information held in the csv, I could implement it

@Bachibouzouk I don't know how long this takes. If it only takes 15 minutes, we should implement this. Otherwise let's shift it to the follow-up project

I you fill the "see_also" column of the "MVS_parameters_list.csv", with the corresponding information (where it is used in the online app, separated by ; if more than one value), then I can easily display this on the docs. The question is how long does this take?

a-linke · 2023-06-22T09:40:07Z

docs/getting_started/quick_start_guide.rst

+
+The above constraints apply to the entire system, but not to specific sectors individually.
+
+


After setting up my scenario, components and constraints clicking on "next" or "simulation" leads to an Server Error (s. screenshots)

c-moeller

First review from my side. Will continue tomorrow.

docs/getting_started/quick_start_guide.rst

c-moeller · 2023-06-28T16:05:45Z

docs/getting_started/quick_start_guide.rst

+
+CREATE AN ACCOUNT
+^^^^^^^^^^
+The first step to start using open_plan is to create an account. To do this, you must click on the "Sign up" button at the top right corner and fill in the following information: your name, email address, username and password. Finally, do not forget to read and accept the privacy statement. You should receive an email with a link to confirm the account creation. 


Suggested change

The first step to start using open_plan is to create an account. To do this, you must click on the "Sign up" button at the top right corner and fill in the following information: your name, email address, username and password. Finally, do not forget to read and accept the privacy statement. You should receive an email with a link to confirm the account creation.

The first step to start using open_plan is to create an account. To do this, you must click on the "Sign up" button at the top right corner and fill in the following information: your name, email address, username and password. Finally, do not forget to read and accept the privacy statement. You should receive an email with a link to confirm the account creation. You can find our privacy policy here: xxxx

@Bachibouzouk please add the link to the privacy policy

c-moeller · 2023-06-28T16:08:04Z

docs/getting_started/quick_start_guide.rst

+
+**1. Logo. Clicking here will take you back to the home screen.**
+
+**2. Top navigation menu. Located on the upper right part of the screen, here you will find the shortcuts to:**


Top navigation menu has changed. We need an updated picture.

We still need, right @c-moeller ?

docs/getting_started/quick_start_guide.rst

c-moeller · 2023-06-29T15:29:40Z

docs/model/parameters/.gitkeep

This is because it comes from the MVS documentation. @NargesChinichian can you create a link in the table of contents under Model Reference?

c-moeller · 2023-06-29T15:34:16Z

docs/index.rst

+.. toctree::
+   :hidden:
+   :maxdepth: 2
+   :caption: Use Cases


@NargesChinichian Could you create an intermediate level with another tab called "Use cases" (which would be on the level where each example is now) and shift the examples to a level below (like "First steps/FAQ" in "Quick start"). Thus we could also include the overall description of the use case side which Catalina prepared.

@c-moeller So as far as I know, the answer is no. The table of content drop-down subtitles is created from the subtitles in a single ".rst" file. When you click on them, like the wikipedia table of content, you just jump to that section on the same page [you are not taken to another page]. I can add all examples together with the meta text Catalina wrote on one page and then the subtitles for each example would work as they work on the "Quick start/ First steps" section drop-down. Would that be more desirable?
There might also be another way of doing this with an intermediate full page but I couldn't find it. Maybe @Bachibouzouk knows something?

I am not exactly sure what needs to be done here, I will try to clarify it with in person discussion

docs/getting_started/quick_start_guide.rst

Add the file to the documentation although there are still some comments in it (in german mostly)

@c-moeller

Suggestions from @c-moeller Co-authored-by: Caroline Möller <[email protected]>

Deprecated python.version

FredericHirschmueller and others added 24 commits December 1, 2021 15:52

Update README.md

b9119fb

Update README.md

f7e8088

Update README.md

365e24f

Update README.md

edf191d

Add documentation from old repository

4fdb40e

Add RTD badge

f0561be

Add requirements.txt

da07be3

Create .readthedocs.yml

8d1b762

Merge pull request #98 from open-plan-tool/auto-build-RTD

d784edf

Setup auto-build RTD

fix copyright and import

4cfc4ae

change link to other pages and some content

beb431c

Implement new content written by Catalina

3f6052a

add contact us and question ref

37efd74

Add images for quick start.

bf960dc

Implement more details and images on quick start guide.

e355407

correct PNG to png.

6bb2f82

Remove content from mvs. Add "under construction".

891c8f1

Fix spacing.

cd0e7c0

change based on github_outline draft content.

a7606f3

Merge pull request #100 from open-plan-tool/add-documentation-content

46107e6

Add documentation content

Update index.rst

e21d138

Spelling mistake corrected

Merge pull request #101 from open-plan-tool/FredericHirschmueller-pat…

e163e98

…ch-2 Update index.rst

Update .readthedocs.yml

70d49b4

Merge pull request #102 from open-plan-tool/feature/enable-pdf-build

56aabf2

Enable pdf build

c-moeller self-assigned this Jun 15, 2023

c-moeller requested a review from a team June 15, 2023 14:51

a-linke reviewed Jun 21, 2023

View reviewed changes

docs/model/parameters/MVS_parameters_categories.inc Show resolved Hide resolved

a-linke reviewed Jun 21, 2023

View reviewed changes

a-linke reviewed Jun 22, 2023

View reviewed changes

c-moeller commented Jun 28, 2023

View reviewed changes

c-moeller commented Jun 29, 2023

View reviewed changes

c-moeller commented Jul 6, 2023

View reviewed changes

docs/getting_started/quick_start_guide.rst Show resolved Hide resolved

Bachibouzouk and others added 14 commits December 11, 2023 11:45

Comment out end of mathematics simply explained

efef8d0

Add the file to the documentation although there are still some comments in it (in german mostly)

Add commented out section

dfd08ff

Fix rst title

901421c

Update the MVS parameters

759f063

Replace open_plan tool by open-plan-tool

754b260

Add readme content

0d0f275

Add references page

734600f

Fix parameter docs

2fd2a4e

Update rtd config file

116bc4b

Apply suggestions from code review

e8e1a0c

Suggestions from @c-moeller Co-authored-by: Caroline Möller <[email protected]>

Fix RTD config file

05b8c41

Deprecated python.version

Add link to privacy policy

072c658

Attempt to fix equation display

7fdd907

Fix warnings

fa1a3cc

Bachibouzouk force-pushed the dev branch from 7a79ad7 to b36bc15 Compare December 11, 2023 13:54

Add latex to apt package of RTD config file

8b64260

Bachibouzouk force-pushed the dev branch from b36bc15 to 8b64260 Compare December 11, 2023 14:03

Bachibouzouk added 2 commits December 11, 2023 15:07

Try settings similar to oemof-solph

59e66c1

Remove latex installation to see if this still displays math

151af8f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Review of the documentation #105

Review of the documentation #105

c-moeller commented Jun 15, 2023

a-linke Jun 21, 2023

Bachibouzouk Jun 21, 2023

a-linke Jun 21, 2023

a-linke Jun 21, 2023

Bachibouzouk Jun 21, 2023

a-linke Jun 22, 2023

Bachibouzouk Jun 22, 2023

c-moeller Dec 11, 2023

Bachibouzouk Dec 11, 2023

a-linke Jun 21, 2023

c-moeller Jun 29, 2023

NoCh-Git Jun 30, 2023

c-moeller Jul 6, 2023

a-linke Jun 21, 2023

c-moeller Jun 29, 2023

NoCh-Git Jun 30, 2023

NoCh-Git Jun 30, 2023

c-moeller Jul 6, 2023

c-moeller Jul 6, 2023

a-linke Jun 21, 2023

Bachibouzouk Jul 4, 2023

c-moeller Dec 11, 2023

Bachibouzouk Dec 11, 2023

a-linke Jun 22, 2023

c-moeller left a comment

c-moeller Jun 28, 2023

c-moeller Jun 28, 2023

c-moeller Dec 11, 2023

c-moeller Jun 28, 2023

Bachibouzouk Dec 11, 2023

c-moeller Jun 29, 2023

c-moeller Jun 29, 2023

NoCh-Git Jun 30, 2023

Bachibouzouk Jul 4, 2023



		Before proceeding to the next section, be sure to complete the information requirements for each component and save the energy system.


		The above constraints apply to the entire system, but not to specific sectors individually.


		1. Logo. Clicking here will take you back to the home screen.

		2. Top navigation menu. Located on the upper right part of the screen, here you will find the shortcuts to:

Review of the documentation #105

Are you sure you want to change the base?

Review of the documentation #105

Conversation

c-moeller commented Jun 15, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

c-moeller left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment