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

Cite?

Browse Source
This commit is contained in:
Dominik Moritz Roth 2024-10-02 19:47:49 +02:00
parent d580f77fce
commit 08a60e2850
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -65,11 +65,11 @@ Parameter properties:
Parameter methods: Parameter methods:
- `Nucon.<PARAMETER>.read()`: Get the current value of the parameter (alias for `value`) - `Nucon.<PARAMETER>.read()`: Get the current value of the parameter (alias for `value`)
- `Nucon.<PARAMETER>.write(new_value, force=False)`: Write a new value to the parameter. `force` will try to write even if the parameter is known as non-writable. - `Nucon.<PARAMETER>.write(new_value, force=False)`: Write a new value to the parameter. `force` will try to write even if the parameter is known as non-writable or out of known allowable range.
Class methods: Class methods:
- `Nucon.get(parameter)`: Get the value of a specific parameter. Also accepts string parameter names. - `Nucon.get(parameter)`: Get the value of a specific parameter. Also accepts string parameter names.
- `Nucon.set(parameter, value, force=False)`: Set the value of a specific parameter. Also accepts string parameter names. - `Nucon.set(parameter, value, force=False)`: Set the value of a specific parameter. Also accepts string parameter names. `force` will try to write even if the parameter is known as non-writable or out of known allowable range.
- `Nucon.get_all_readable()`: Get a list of all readable parameters (which is all parameters) - `Nucon.get_all_readable()`: Get a list of all readable parameters (which is all parameters)
- `Nucon.get_all_writable()`: Get a list of all writable parameters - `Nucon.get_all_writable()`: Get a list of all writable parameters
- `Nucon.get_all()`: Get all parameter values as a dictionary - `Nucon.get_all()`: Get all parameter values as a dictionary
@ -149,3 +149,15 @@ The tests verify:
## Disclaimer ## Disclaimer
NuCon is an unofficial tool and is not affiliated with or endorsed by the creators of Nucleares. NuCon is an unofficial tool and is not affiliated with or endorsed by the creators of Nucleares.
## Citing
What? Why would you wanna cite it? What are you even doing?
```
@misc{nucon,
title = {NuCon},
author = {Dominik Roth},
abstract = {NuCon is a Python library to interface with and control Nucleares, a nuclear reactor simulation game. Includes gymnasium bindings for Reinforcement Learning.}
url = {https://git.dominik-roth.eu/dodox/NuCon},
year = {2024},
}
```