Skip to content

Model_Equations#581

Merged
smartie2076 merged 67 commits intodevfrom
Model_equations
Nov 5, 2020
Merged

Model_Equations#581
smartie2076 merged 67 commits intodevfrom
Model_equations

Conversation

@ursulaelmir
Copy link
Copy Markdown
Collaborator

@ursulaelmir ursulaelmir commented Sep 30, 2020

Fix #574

Changes proposed in this pull request:

  • Create separate file for model equations
  • Describe the economic model
  • Describe component models
  • Energy balance equations
  • Sector coupled example

The following steps were realized, as well (if applies):

  • Update the CHANGELOG.md
  • Apply black (black . --exclude docs/)
  • Check if benchmark tests pass locally (EXECUTE_TESTS_ON=master pytest)

Please mark above checkboxes as following:

  • Open
  • Done

❌ Check not applicable to this PR

For more information on how to contribute check the CONTRIBUTING.md.

@ursulaelmir ursulaelmir self-assigned this Sep 30, 2020
@ursulaelmir ursulaelmir changed the title Create Model_Equations Model_Equations Sep 30, 2020
@ursulaelmir
Copy link
Copy Markdown
Collaborator Author

hi @smartie2076 , can we merge the new rst file so that I can see the updates on readthedocs?

@smartie2076
Copy link
Copy Markdown
Collaborator

hi @smartie2076 , can we merge the new rst file so that I can see the updates on readthedocs?

Sorry, we can not. You can either make html locally to see your changes, or check this link: https://mvs-eland.readthedocs.io/en/model_equations/

Copy link
Copy Markdown
Collaborator

@smartie2076 smartie2076 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to add the file to Overview.rst to make it show up on readthedocs, but with make html you can already see it.

@smartie2076
Copy link
Copy Markdown
Collaborator

@ursulaelmir please message me directly / mail me when I should check this PR :)

@ursulaelmir
Copy link
Copy Markdown
Collaborator Author

@ursulaelmir please message me directly / mail me when I should check this PR :)

Hi @smartie2076 , to be honest I did not understand what you told me regarding how I can view the equations on readthedocs already

@Bachibouzouk
Copy link
Copy Markdown
Collaborator

Hi @smartie2076 , to be honest I did not understand what you told me regarding how I can view the equations on readthedocs already

Now you should be able to see the build of readthedocs in the checks (you need to push something to retrigger the build.

You need to have a latex compiler installed locally in order to be able to see the equations on a local build.

@ursulaelmir
Copy link
Copy Markdown
Collaborator Author

ursulaelmir commented Oct 6, 2020

Hi @smartie2076 , to be honest I did not understand what you told me regarding how I can view the equations on readthedocs already

Now you should be able to see the build of readthedocs in the checks (you need to push something to retrigger the build.

You need to have a latex compiler installed locally in order to be able to see the equations on a local build.

@Bachibouzouk I still can't see it on readthedocs. It's fine I will write all the equations then we see which ones don't show properly

@smartie2076
Copy link
Copy Markdown
Collaborator

You can not see the equations because you did not add the file to theindex.rst file at the appropriate place below .. toctree::.

If you execute in the terminal:
cd docs
make html
You can find the locally compiled html pages in docs/_build/html.

@ursulaelmir
Copy link
Copy Markdown
Collaborator Author

You need to add the file to Overview.rst to make it show up on readthedocs, but with make html you can already see it.

@smartie2076 that's why I wasn't getting it!

@smartie2076
Copy link
Copy Markdown
Collaborator

You need to add the file to Overview.rst to make it show up on readthedocs, but with make html you can already see it.

@smartie2076 that's why I wasn't getting it!

Yeah, I was confused. Is it clear now?

@ursulaelmir
Copy link
Copy Markdown
Collaborator Author

You need to add the file to Overview.rst to make it show up on readthedocs, but with make html you can already see it.

@smartie2076 that's why I wasn't getting it!

Yeah, I was confused. Is it clear now?

yes, thanks!

@ursulaelmir
Copy link
Copy Markdown
Collaborator Author

hi @smartie2076 , I think the equations are now all included. maybe you can have a look at the example components and abbreviations used and so on and let me know if anything needs to be changed or added. otherwise I would mark this as ready for review :)

@smartie2076
Copy link
Copy Markdown
Collaborator

Hi @ursulaelmir! I am on vacation currently, so I can't review the PR. I will check it first thing after my return.

@smartie2076 smartie2076 mentioned this pull request Nov 4, 2020
9 tasks
@smartie2076
Copy link
Copy Markdown
Collaborator

I like what you did and proposed some small changes in #627. Can you post the file you used for the image here, so that we can change it later if necessary?

@smartie2076
Copy link
Copy Markdown
Collaborator

After merging #627, this one is ready to merge! Yay!

@ursulaelmir
Copy link
Copy Markdown
Collaborator Author

Can you post the file you used for the image here, so that we can change it later if necessary?

the file type is not supported (.drawio). i can send it to you by email

@smartie2076
Copy link
Copy Markdown
Collaborator

Can you post the file you used for the image here, so that we can change it later if necessary?

the file type is not supported (.drawio). i can send it to you by email

You can compess it in a .zip to upload it, but you can also send it to me via mail.

This PR does not change any code, so it can be merged into the next PR.
@smartie2076 smartie2076 marked this pull request as ready for review November 5, 2020 11:15
@smartie2076 smartie2076 merged commit 8eb3d27 into dev Nov 5, 2020
@smartie2076 smartie2076 deleted the Model_equations branch November 5, 2020 11:16
@smartie2076
Copy link
Copy Markdown
Collaborator

Congratiulations @ursulaelmir! Your last PR is merged. Thank you for the effort you put into it after the official end :)
Your thesis is now linked on our RLI website as well, btw.

@ursulaelmir
Copy link
Copy Markdown
Collaborator Author

@smartie2076 here you go :)

Schematic.zip

@smartie2076 smartie2076 mentioned this pull request Nov 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Equations of the model

3 participants