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

Fix typo + better install instructions

Browse Source
This commit is contained in:
Dominik Moritz Roth 2024-10-08 17:21:02 +02:00
parent c0a9ec33a0
commit 66481d8486
1 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -5,7 +5,7 @@ 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.
> Nucleares 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
@ -28,7 +28,7 @@ pip install -e .
Here's a basic example of how to use NuCon:
```python
from nucon import Nucon, BreakerStatus
from nucon import Nucon
nucon = Nucon()
# or nucon = Nucon(host='localhost', port=8786)
@ -45,12 +45,8 @@ pump_status = nucon.COOLANT_CORE_CIRCULATION_PUMP_0_STATUS.value
print(f"Pump 0 Status: {pump_status}")
# Write to a parameter
nucon.GENERATOR_0_BREAKER.value = BreakerStatus.OPEN # or True
print(f"Generator 0 Breaker Status: {nucon.GENERATOR_0_BREAKER.value}")
# Use custom truthy values
if nucon.COOLANT_CORE_CIRCULATION_PUMP_0_STATUS.value:
print("Pump 0 is active")
nucon.RODS_POS_ORDERED.value = 50
print(f"Generator 0 Breaker Status: {nucon.GRODS_POS_ORDERE.value}")
```
## API Reference
@ -93,10 +89,10 @@ NuCon includes a preliminary Reinforcement Learning (RL) environment based on th
### Additional Dependencies
To use you'll need to install the following packages:
To use you'll need to install `gymnasium` and `numpy`. You can do so via
```bash
pip install -e .[rl] # gymnasium numpy
pip install -e '.[rl]'
```
### RL Environment
@ -143,10 +139,10 @@ NuCon provides a built-in simulator to address the challenge of slow training ti
### Additional Dependencies
To use you'll need to install the following packages:
To use you'll need to install `torch` and `flask`. You can do so via
```bash
pip install -e .[sim] # torch flask
pip install -e '.[sim]'
```
### Usage
@ -193,10 +189,10 @@ To address the challenge of unknown game dynamics, NuCon provides tools for coll
### Additional Dependencies
To use you'll need to install the following packages:
To use you'll need to install `torch` and `numpy`. You can do so via
```bash
pip install -e .[model] # torch numpy
pip install -e '.[model]'
```
### Usage:
@ -225,7 +221,7 @@ The trained models can be integrated into the NuconSimulator to provide accurate
## Testing
NuCon includes a test suite to verify its functionality and compatibility with the Nucleares game.
NuCon includes a test suite to verify its functionality and compatibility with the Nucleares game.
### Running Tests
@ -253,10 +249,10 @@ The tests verify:
![NuCon Meme](README_meme.jpg)
To use you'll need to install the following packages:
To use you'll need to install `pillow`. You can do so via
```bash
pip install -e .[drake] # pillow
pip install -e '.[drake]'
```
### Usage: