Small updates (#128)

* Feature 100 additional rl (#110)

* initital file to start working with

* bugfixes

* update

* #100 add td3 agent

* #100 add test scripts

* #100 convert action space using wrappers

* #100 add experiments with td3

* fix `TD3Policy` not defined

* adapt td3 to multi dims action and state

* #100 log first results with TD3

* #100 add wandb support

* #100 add notebook example for `TD3`

* #100 fix `max_steps` not defined

* #100 re organise

* fix spelling

* #100 add wandb logged plots

* add wandb, statistcs, revise to project toml

* #100 rm wandb

* #100 fix multiple methods with same name

* #100 fix infos

* #100 rm Wandb

* #100 fix minor issues

* #100 add `wandb` example

* #100 update with figures

* #100 remove `@show`

---------

Co-authored-by: Jan Stenner <[email protected]>

* initial GUI commit

* Feature 23 modeling variable dc link voltage (#118)

* #23 Save for merge.

* #23 Add battery notebook.

* #23 Start plotting the data.

* Added Plotly.js

* Adjusting the notebook and src to the current version.

* Changed function within PV arrays. Added battery model. Changed DEMO PV to DC link models.

* Commiting current state of the notebook. Implementation to Env is still missing.

* Implementing variable dc link voltage.

* Include variable_dc_link.jl

* Deleted Prints and added stuff to nb

* Updated parameter check. Added default values for battery and pv.

* Changed temperature offset to match the one in the battery.

* Finalization of DC Link voltages, adding two example scripts and one example notebook.

* Fixed bug in the pv array

* Update project.toml

* Added check for the source_type key.

* Corrected calculation of DC link voltages.

* #118 Corrected typos

* Cleaned up code. Added calculation of v_dc to env.reset.

* Cleared notebook and added figures.

* Revert "Merged changes."

This reverts commit 2d20e95, reversing
changes made to 9d25c2c.

---------

Co-authored-by: Marvin Meyer <[email protected]>
Co-authored-by: webbah <[email protected]>

* Feature 96 non linear modelling (#120)

* small test file non linear

* test_non_linear

* added Nodconstructor test for nonlinear things

* update

* smal Test

* update: same result as in the nodeconstructor

* update

* update

* update

* small update

* another try

* NodeConstructor works with functions

* Update:
- node_constructor.jl
- electric_grid_env.jl
Both work with nonlinearity

* Small changed using DifferentialEqautions.jl

* small updates

* Update Env

* update: env_example_nonlinear.jl

* updated env_example_nonlinear.jl
and custom_crontrol.jl to get the last x value. Nothing in the middle

* Changed the accuracy of the ODE solver to speed up

* minor changes

* Info for the solver

* Updated Info, and small Notebook

* Reexport added

* merge ended

* Toml update

* fixed nameof bug and updated the Project.toml

* Deleted unnecessary things

* Updated Nonlinear.ipynb

---------

Co-authored-by: Jan Stenner <[email protected]>

* gui update

* mini gui fix

* import Interpolations.LinearInterpolation

* docs update 1

* docs update 2

* RL example preparation 2

* RL example updates

* Changed dtype of the matrix to Float. (#121)

* RL update

* added fixes and osc feature from RL Classic branch

* updates to RL Single Example (also notebook&docs)

* Feature 96 non linear modelling (#123)

* small test file non linear

* test_non_linear

* added Nodconstructor test for nonlinear things

* update

* smal Test

* update: same result as in the nodeconstructor

* update

* update

* update

* small update

* another try

* NodeConstructor works with functions

* Update:
- node_constructor.jl
- electric_grid_env.jl
Both work with nonlinearity

* Small changed using DifferentialEqautions.jl

* small updates

* Update Env

* update: env_example_nonlinear.jl

* updated env_example_nonlinear.jl
and custom_crontrol.jl to get the last x value. Nothing in the middle

* Changed the accuracy of the ODE solver to speed up

* minor changes

* Info for the solver

* Updated Info, and small Notebook

* Reexport added

* merge ended

* Toml update

* fixed nameof bug and updated the Project.toml

* Deleted unnecessary things

* Updated Nonlinear.ipynb

* changes Notebook

* Updated notebook

* Update Project.toml

---------

Co-authored-by: Benedikt Brück <[email protected]>
Co-authored-by: Benedikt Brück <[email protected]>
Co-authored-by: Jan Stenner <[email protected]>
Co-authored-by: Jan Stenner <[email protected]>

* cleanup: Nonlinear Notebook and RLtests

Docs update: New Nonlinear contents and fixed a bug with multiple plots per page ("gd" to "gdd" etc.) BY HAND

* cleanup

* cleanup and minor fixes again

* Update README.md (#127)

correct typo

* Feature 102 extended unit tests (#126)

* #101 Add tests for other voltages

* #45 extended tests

* delete `RL_tests`

---------

Co-authored-by: Vikas <[email protected]>
Co-authored-by: webbah <[email protected]>
Co-authored-by: MarvinMeyer <[email protected]>
Co-authored-by: Marvin Meyer <[email protected]>
Co-authored-by: Benedikt Brück <[email protected]>
Co-authored-by: Benedikt Brück <[email protected]>
Co-authored-by: Oliver Wallscheid <[email protected]>

README.md

@@ -26,7 +26,7 @@ ElectricGrid.jl is a library for setting up realistic electric grid simulations
 
 ## Installation
 - Installation using the julia package manager (recommended if you want to use ElectricGrid in your project):
-  - In a julia terminal run the follwing:
+  - In a Julia terminal run the follwing:
 ```
 import Pkg
 Pkg.add("ElectricGrid")
@@ -74,7 +74,7 @@ There should also appear a plot that looks like this:
 
 The current version of ElectricGrid features a graphical user interface (GUI) that helps with setting up a simulation.
 This is built on the library [QML.jl](https://github.com/JuliaGraphics/QML.jl), that, at the time of writing, stopped working in it's current release version.
-For that reason it is required to install `QML.jl` in it's github main state manually if you want to use the gui.
+For that reason it is **required to clone this codebase** and install `QML.jl` in it's github main state manually if you want to use the gui.
 
 ```
 import Pkg
@@ -87,4 +87,4 @@ add QML#main
 
 ![gui example](docs/src/assets/gui_example.png)
 
-Usage of the GUI is explained in the [GUI section in the docs](https://upb-lea.github.io/ElectricGrid.jl/dev/Gui/).
+Usage of the GUI is explained in the [GUI section in the docs](https://upb-lea.github.io/ElectricGrid.jl/dev/Gui/).