summaryrefslogtreecommitdiff
path: root/site/docs/documentation/Input/Topology/Battery.md
diff options
context:
space:
mode:
authorDante Niewenhuis <d.niewenhuis@hotmail.com>2025-05-16 10:32:08 +0200
committerGitHub <noreply@github.com>2025-05-16 10:32:08 +0200
commitd70312f122d9ef7c31b05757239ffc66af832dee (patch)
treec8eb5d86ce751b783c3f15744bcda35861eed65d /site/docs/documentation/Input/Topology/Battery.md
parent1bc17abd7691bc81f11ee125e2eeb4cb08da5245 (diff)
Updated website documentation (#334)
* Updated website documentation * Updated some documentation and fixed links * small updates * small updates
Diffstat (limited to 'site/docs/documentation/Input/Topology/Battery.md')
-rw-r--r--site/docs/documentation/Input/Topology/Battery.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/site/docs/documentation/Input/Topology/Battery.md b/site/docs/documentation/Input/Topology/Battery.md
new file mode 100644
index 00000000..70492694
--- /dev/null
+++ b/site/docs/documentation/Input/Topology/Battery.md
@@ -0,0 +1,37 @@
+Batteries can be used to store energy for later use.
+In previous work, we have used batteries to store energy from the grid when the carbon intensity is low,
+and use this energy when the carbon intensity is high.
+
+Batteries are defined using the following parameters:
+
+| variable | type | Unit | required? | default | description |
+|------------------|---------------------------|-------|-----------|---------|-----------------------------------------------------------------------------------|
+| name | string | N/A | no | Battery | The name of the battery. This is only important for debugging and post-processing |
+| capacity | Double | kWh | yes | N/A | The total amount of energy that the battery can hold. |
+| chargingSpeed | Double | W | yes | N/A | Charging speed of the battery. |
+| initialCharge | Double | kWh | no | 0.0 | The initial charge of the battery. If not given, the battery starts empty. |
+| batteryPolicy | [Policy](#battery-policy) | N/A | yes | N/A | The policy which decides when to charge and discharge. |
+| embodiedCarbon | Double | gram | no | 0.0 | The embodied carbon emitted while creating this battery. |
+| expectedLifetime | Double | Years | yes | 0.0 | The expected lifetime of the battery. |
+
+## Battery Policy
+To determine when to charge and discharge the battery, a policy is required.
+Currently, all policies for batteries are based on the carbon intensity of the grid.
+
+The best performing policy is called "runningMeanPlus" and is based on the running mean of the carbon intensity.
+it can be defined with the following JSON:
+
+```json
+{
+ "type": "runningMeanPlus",
+ "startingThreshold": 123.2,
+ "windowSize": 168
+}
+```
+
+In which `startingThreshold` is the initial carbon threshold used.
+`windowSize` is the size of the window used to calculate the running mean.
+
+:::info Alert
+This page with be extended with more text and policies in the future.
+:::