From c0a9ec33a0943d948f71d767d87fd562aeea3fcb Mon Sep 17 00:00:00 2001 From: Dominik Roth Date: Mon, 7 Oct 2024 17:11:44 +0200 Subject: [PATCH] README: Added Note about current capabilities --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 460ccd1..703d571 100644 --- a/README.md +++ b/README.md @@ -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}, } -``` \ No newline at end of file +```