Skip to content

Commit

Permalink
docs: fix various stuff in user guides (formatting, toc links, ...)
Browse files Browse the repository at this point in the history
  • Loading branch information
sstroemer authored Oct 29, 2024
1 parent 42be81f commit 1dd0874
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/pages/user_guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ These user guides cover a wide range of topics, going into detail on specifics,
:hidden:
:caption: User guides

pages/user_guides/toc_general.md
pages/user_guides/toc_qna.md
toc_general.md
toc_qna.md
:::
4 changes: 2 additions & 2 deletions docs/pages/user_guides/qna/passive_charging.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## Intro

> **Question:**
**Question:**
> How can I represent passive charging in a borehole heat storage within my energy system optimization model?
> **Answer:**
**Answer:**
> It's complicated ... But the only generally applicable answer is: A custom addon. The underlying idea is to separate the passive charging from the storage, into a separate "artificial" Profile, that can then accurately depict the passive behavior.
## The problem
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/user_guides/qna/profiles_sign.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## Intro

> **Question:**
**Question:**
> How does IESopt interpret positive and negative values in a Profile connected using `node_from`?
> **Answer:**
**Answer:**
> When modeling energy systems in IESopt, you might have a fixed Profile representing both energy demand and supply — the proper sign of generation / consumption then depends on the way it is configured and connects to other components. Understanding how to correctly connect this Profile to a Node is crucial for accurate results.
## Details
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/user_guides/qna/snapshot_duration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## Intro

> **Question:**
**Question:**
> I'm moving from hourly to daily time steps in my IESopt model. How should I adjust my input data, especially capacities and costs, to ensure accurate results? Should I express capacities as energy per time step (e.g., kWh/day) instead of power (kW)?
> **Answer:**
**Answer:**
> When working with IESopt models, it's crucial to understand how the model interprets units of power and energy, especially when changing the duration of your time steps (snapshots). Here's how to approach this:
## Details
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/user_guides/toc_general.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Crafted user guides covering a specific topic. These are mostly used to explain
## Contents

:::{toctree}
:maxdepth: 2
:maxdepth: 1

general/best_practice.md
general/linking_components.md
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/user_guides/toc_qna.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# General
# Q & A

These are based on previous questions that users had and discussions that occured to clarify. They can be used to point users to for any questions that repeatedly occur.

## Contents

:::{toctree}
:maxdepth: 2
:maxdepth: 1

qna/snapshot_duration.md
qna/profiles_sign.md
Expand Down

0 comments on commit 1dd0874

Please sign in to comment.