Skip to content

Minor RTD changes#876

Merged
smartie2076 merged 16 commits intodevfrom
rtd/minor_rtd_changes
May 31, 2021
Merged

Minor RTD changes#876
smartie2076 merged 16 commits intodevfrom
rtd/minor_rtd_changes

Conversation

@TheOneAndra
Copy link
Copy Markdown
Collaborator

@TheOneAndra TheOneAndra commented May 3, 2021

Fix #828 #699

Changes proposed in this pull request:

  • Add an example for fix capacity of asset and still take into account installations costs.
  • Complete SOC definitions
  • Correct typo in docs/model/assumptions.rst

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

  • Use in-line comments to explain your code
  • Write docstrings to your code (example docstring)
  • For new functionalities: Explain in readthedocs
  • Write test(s) for your new patch of code (pytests, assertion debug messages)
  • 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.

@TheOneAndra TheOneAndra requested a review from smartie2076 May 3, 2021 10:09
@TheOneAndra
Copy link
Copy Markdown
Collaborator Author

All suggestions applied @smartie2076 :)

@smartie2076
Copy link
Copy Markdown
Collaborator

@ciaradunks @Bachibouzouk is this explaination for the sunk cost workaround understandable for you?

@Bachibouzouk
Copy link
Copy Markdown
Collaborator

Bachibouzouk commented May 4, 2021

@TheOneAndra, @smartie2076 - I would structure the narrative differently, stating

  1. what is the problem you are trying to tackle (with a specific example to provide a friendly image via a possible usecase, which is currently lacking)
  2. why is it a problem
  3. what do you do to tackle the problem
  4. how good your solution is
  5. possible problem associated to your solution

I would also not hide the title "Including sunk costs for previous investments into specific assets" under "Tips & Tricks". I would simply not have "Tips & Tricks" as a title, rather direcly "Including sunk costs for previous investments into specific assets" (shouldn't it be from instead of for?)

@TheOneAndra
Copy link
Copy Markdown
Collaborator Author

I would structure the narrative differently, stating

1. what is the problem you are trying to tackle (with a specific example to provide a friendly image via a possible usecase, which is currently lacking)

2. why is it a problem

3. what do you do to tackle the problem

4. how good your solution is

5. possible problem associated to your solution

Would result in something like:

Usually, the investments into existing capacities are neglected and assumed to be sunk costs of the system. The existing capacity :code:installedCap as well as the age of the installed asset :code:age_installed are only used to calculate when necessary re-investments take place, and how high the :ref:replacements costs <Cost_calculations> are.

When optimizing a system with pre-existing capacities of certain assets, it can be usefull for the user to implement the installation costs of these assets in the economic evaluation.

With this, it is possible to optimize a system with a specific or a specific minimal capacity of a certain asset and still account for installation costs of the asset at the beginning of the project (in the idea of a greenfield / brownfield optimization). This can work for energy production assets as well as energy conversion assets.

For this, following trick can be applied to the input data of the asset in question, by setting:

  • :code:optimizeCap to False

  • :code:installedCap to the specific existing capacity

  • :code:aged_installed to the lifetime of the asset

Previous investment costs into now pre-existing asset capacities are now taken into account in the economic evaluation of a scenario.

I would also not hide the title "Including sunk costs for previous investments into specific assets" under "Tips & Tricks". I would simply not have "Tips & Tricks" as a title, rather direcly "Including sunk costs for previous investments into specific assets"

That was the original idea but @smartie2076 didn't like it.

@Bachibouzouk
Copy link
Copy Markdown
Collaborator

Bachibouzouk commented May 4, 2021

@TheOneAndra - can you implement the changes you proposed so we can discuss individual sentences within the github interface :) ?

@smartie2076
Copy link
Copy Markdown
Collaborator

I would also not hide the title "Including sunk costs for previous investments into specific assets" under "Tips & Tricks". I would simply not have "Tips & Tricks" as a title, rather direcly "Including sunk costs for previous investments into specific assets"

That was the original idea but @smartie2076 didn't like it.

I think that the list of tips & tricks can get really expansive, so I am not really favouring to have a lot of files and a lot of sections in the example chapter. I would probably say we gather them under that name, and then at the appropriate places reference to the sections, eg. in the input paramater explainations and the cost evaluation assumtions.

@Bachibouzouk
Copy link
Copy Markdown
Collaborator

I think that the list of tips & tricks can get really expansive

I agree. However, right now there is only one tip in "Tips and Tricks", what is the likelyhood that you have more than 2 before the report is submitted? We can leave it as is, the final decision is up to you

@smartie2076
Copy link
Copy Markdown
Collaborator

@TheOneAndra can you follow up with the comments of @Bachibouzouk?

@TheOneAndra TheOneAndra requested a review from Bachibouzouk May 25, 2021 12:29
Copy link
Copy Markdown
Collaborator

@Bachibouzouk Bachibouzouk left a comment

Choose a reason for hiding this comment

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

Thanks @TheOneAndra , can you rebase on the latest stand of dev? Then you can merge :)

@TheOneAndra
Copy link
Copy Markdown
Collaborator Author

Changelog updated @smartie2076

@smartie2076 smartie2076 merged commit 3f3ce30 into dev May 31, 2021
@smartie2076 smartie2076 deleted the rtd/minor_rtd_changes branch May 31, 2021 11:00
@smartie2076 smartie2076 mentioned this pull request May 31, 2021
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.

Add tips&tricks to RTD (1. Andras fix)

3 participants