https://github.com/projecttorreypines/simulationparameters.jl
Advanced handing of nested input simulation parameters
https://github.com/projecttorreypines/simulationparameters.jl
Last synced: 10 months ago
JSON representation
Advanced handing of nested input simulation parameters
- Host: GitHub
- URL: https://github.com/projecttorreypines/simulationparameters.jl
- Owner: ProjectTorreyPines
- License: apache-2.0
- Created: 2023-01-05T18:27:56.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-15T20:53:32.000Z (almost 2 years ago)
- Last Synced: 2024-08-15T22:31:55.835Z (almost 2 years ago)
- Language: Julia
- Homepage: https://projecttorreypines.github.io/SimulationParameters.jl/dev
- Size: 353 KB
- Stars: 0
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SimulationParameters.jl
SimulationParameters.jl provides handing of hierarchical input simulation parameters
* enforcing type
* with descriptions
* with units
* with checks
There are three key abstract parameters types:
* `AbstractParameters` define hierarchical containers (think of dictionaries)
* `AbstractParametersVector` hold arrays of hierarchical containers
* `AbstractParameter` hold individual parameters
There are two concrete types of `AbstractParameter`:
* `Entry` where the value can be set by the user
* `Switch` which allows users to select from a limited se of `SwitchOption`s
Both `Entry` and `Switch` support the definition of ranges/functions that can be used by optimizers to vary values for each of the parameters.
## Online documentation
For more details, see the [online documentation](https://projecttorreypines.github.io/SimulationParameters.jl/dev).
