463 general tutorial notebook fixes

[AndreasEppler]

Pull Request

Description

General fixes concerning notebooks and formatting of documentation

Changes Proposed

Docu:

learning.rst:

• fixed typos
• Indices in {}

learning_algorithm.rst:

• typo fixes

Notebooks:

All Notebooks:

• added if-clause to Shell commands that should only be called in colab so that run-all-cells can be run locally as well as in colab without executing "wrong" code cells
• Fixed typos

examples/notebooks/01_minimal_manual_example.ipynb:

• in markdown: demand_operator was called my_demand, demand_unit was called demand_1, was corrected.

examples/notebooks/02_automated_run_example.ipynb:

• In outline: Added internal document links to different chapters.
• Changed location of one descriptive cell to be right beneath code cell

examples/notebooks/03_custom_unit_example.ipynb:

• md: changed non-existing "Fixed Cost" Attribute to "Additional Cost" as it is called in the code
• In outline: Added internal document links to different chapters.

examples/notebooks/04_reinforcement_learning_example.ipynb:

• architecture.svg was not displayed, added python code to Display the desired figure

examples/notebooks/05_market_comparison.ipynb:

• colab cd-commands tried to direct to "assume" instead of the cloned "assume-repo"
• Fixed Header numbers

examples/notebooks/06_advanced_orders_example.ipynb:

• fixed tutorial 06 to align with clearing changes with regard to node solver and incidence matrix definition

examples/notebooks/07_interoperability_example.ipynb:

• Changed amiris-examples folders location to be in notebooks/inputs to be ignored by git.
• In outline: Added internal document links to different chapters.

examples/notebooks/08_market_zone_coupling.ipynb:

• In outline: Added internal document links to different chapters.

examples/notebooks/09_example_Sim_and_xRL.ipynb:

• fixed missing hyperlinks in the outline.
• fixed link to Deep reinforcement learning tutorial from https://example.com/deep-rl-tutorial to 04_reinforcement_learning_example.ipynb

Testing

Ran each tutorial locally and on Colab

Checklist

Please check all applicable items:

• Code changes are sufficiently documented (docstrings, inline comments, doc folder updates)
• New unit tests added for new features or bug fixes
• Existing tests pass with the changes
• Reinforcement learning examples are operational (for DRL-related changes)
• Code tested with both local and Docker databases
• Code follows project style guidelines and best practices
• Changes are backwards compatible, or deprecation notices added
• New dependencies added to pyproject.toml
• A note for the release notes doc/release_notes.rst of the upcoming release is included
• Consent to release this PR's code under the GNU Affero General Public License v3.0

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.71%. Comparing base (6c1e86a) to head (b07da00).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #489   +/-   ##
=======================================
  Coverage   76.71%   76.71%           
=======================================
  Files          50       50           
  Lines        6412     6412           
=======================================
  Hits         4919     4919           
  Misses       1493     1493           

Flag	Coverage Δ
pytest	76.71% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests