From 08a60e2850a25f972327341c906a948814b28030 Mon Sep 17 00:00:00 2001 From: Dominik Roth Date: Wed, 2 Oct 2024 19:47:49 +0200 Subject: [PATCH] Cite? --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 661bb17..c197943 100644 --- a/README.md +++ b/README.md @@ -65,11 +65,11 @@ Parameter properties: Parameter methods: - `Nucon..read()`: Get the current value of the parameter (alias for `value`) -- `Nucon..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..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: - `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_writable()`: Get a list of all writable parameters - `Nucon.get_all()`: Get all parameter values as a dictionary @@ -149,3 +149,15 @@ The tests verify: ## Disclaimer 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}, +} +```