dodox/NuCon
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

README: Added Note about current capabilities

Browse Source
This commit is contained in:
Dominik Moritz Roth 2024-10-07 17:11:44 +02:00
parent 2e759215a8
commit c0a9ec33a0
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -4,6 +4,9 @@ NuCon is a Python library designed to interface with and control parameters in [
NuCon further provides a work in progress implementation of a reinforcement learning environment for training control policies and a simulator based on model learning.
> [!NOTE]
> Nuclear only exposes RODS_POS_ORDERED as writable parameter, and no parameters about core chemistry e.g. Xenon concentration. While NuCon is already usable, it's capabilities are still very limited based on these restrictions. The capabilites are supposed to be extended in future updates to Nucleares, development on the advanced features (Reinforcement / Model Learning) are paused till then.
## Features
- Enum-based parameter system for type safety and code clarity
@ -294,4 +297,4 @@ What? Why would you wanna cite it? What are you even doing?
url = {https://git.dominik-roth.eu/dodox/NuCon},
year = {2024},
}
```
```