API Reference

SimulationParameters

Missing docstring.

Missing docstring for AbstractParameter. Check Documenter's build log for details.

Missing docstring.

Missing docstring for AbstractParameters. Check Documenter's build log for details.

Missing docstring.

Missing docstring for AbstractParametersVector. Check Documenter's build log for details.

Missing docstring.

Missing docstring for BadParameterException. Check Documenter's build log for details.

SimulationParameters.Entry — Type

Entry{T}(units::String, description::String; default::Union{Missing,T}=missing) where T

Defines a entry parameter

source

Missing docstring.

Missing docstring for InexistentParametersFieldException. Check Documenter's build log for details.

Missing docstring.

Missing docstring for NotsetParameterException. Check Documenter's build log for details.

Missing docstring.

Missing docstring for OptParameter. Check Documenter's build log for details.

SimulationParameters.OverrideParameters — Type

OverrideParameters(original::AbstractParameters; kw...)

OverrideParameters masks the input AbstractParameters parameter such that any subsequent edit to the parameters does not affect the original. This is useful to allow local changes to parameters without affecting the original. It is much more efficient than doing a deepcopy of the original.

source

Missing docstring.

Missing docstring for ParametersVector. Check Documenter's build log for details.

SimulationParameters.Switch — Type

Switch{T}(options::AbstractDict{<:Any,SwitchOption}, units::String, description::String; default=missing) where {T}

Defines a switch parameter

source

Missing docstring.

Missing docstring for SwitchOption. Check Documenter's build log for details.

Missing docstring.

Missing docstring for TimeData. Check Documenter's build log for details.

SimulationParameters.dict2par! — Function

dict2par!(dct::AbstractDict, par::AbstractParameters)

Convert dictionary to AbstractParameters

source

SimulationParameters.float_bounds — Function

float_bounds(parameter::AbstractParameter)

Returns optimization bounds of a parameter (if it has one)

source

Missing docstring.

Missing docstring for grouping_parameters. Check Documenter's build log for details.

SimulationParameters.hdf2par — Function

hdf2par(filename::AbstractString, par::AbstractParameters; kw...)

Loads AbstractParameters from HDF5

source

SimulationParameters.json2par — Function

json2par(filename::AbstractString, par::AbstractParameters)

Loads AbstractParameters from JSON

source

SimulationParameters.jstr2par — Function

jstr2par(json_string::String, par::AbstractParameters)

Loads AbstractParameters from JSON string

source

SimulationParameters.nominal_values — Function

nominal_values(parameter::AbstractParameter)

Returns nominal value of an optimization parameter (if it has one)

source

SimulationParameters.opt_labels — Function

opt_labels(parameters::AbstractParameters)

Returns vector with optimization parameter label(s)

source

SimulationParameters.opt_parameters — Function

opt_parameters(parameters::AbstractParameters, optimization_vector::Vector{AbstractParameter}=AbstractParameter[])

Pack the optimization parameters contained in a high-level parameters AbstractParameters into a optimization_values vector

source

SimulationParameters.par2dict — Function

par2dict(par::AbstractParameters)

Convert AbstractParameters to dictionary

source

SimulationParameters.par2dict! — Function

par2dict!(par::AbstractParameters, dct::AbstractDict)

Convert AbstractParameters to dictionary

source

SimulationParameters.par2hdf — Function

par2hdf(@nospecialize(par::AbstractParameters), filename::String; kw...)

Save AbstractParameters to HDF5

NOTE: kw arguments are passed to HDF5.h5open

source

SimulationParameters.par2json — Function

par2json(@nospecialize(par::AbstractParameters), filename::String; kw...)

Save AbstractParameters to JSON

NOTE: kw arguments are passed to JSON.print

source

SimulationParameters.par2jstr — Function

par2jstr(@nospecialize(par::AbstractParameters); indent::Int=1, kw...)

Returns JSON serialization of AbstractParameters

source

SimulationParameters.par2yaml — Function

par2yaml(@nospecialize(par::AbstractParameters), filename::String; kw...)

Save AbstractParameters to YAML

NOTE: kw arguments are passed to YAML.print

source

Missing docstring.

Missing docstring for par2ystr. Check Documenter's build log for details.

SimulationParameters.parameters_from_opt! — Function

parameters_from_opt!(parameters::AbstractParameters, optimization_values::AbstractVector)

Unpack a optimization_values vector into a high-level parameters AbstractParameters

source

Base.rand — Function

rand!(parameters::AbstractParameters)

Generates a new AbstractParameters with randomized OptParameters

source

Base.rand(parameters::AbstractParameters, field::Symbol)

Generates a new random sample within the OptParameter distribution

source

Base.rand(parameter::AbstractParameter)

Generates a new random sample within the OptParameter distribution

source

SimulationParameters.rand! — Function

rand!(parameters::AbstractParameters)

Randomizes all OptParameters in a AbstractParameters

source

rand!(parameters::AbstractParameters, field::Symbol)

Generates a new random sample within the OptParameter distribution and updates the parameter value

source

rand!(parameter::AbstractParameter)

Generates a new random sample within the OptParameter distribution and updates the parameter value

source

Missing docstring.

Missing docstring for set_new_base!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for setup_parameters!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for show_modified. Check Documenter's build log for details.

SimulationParameters.yaml2par — Function

yaml2par(filename::AbstractString, par::AbstractParameters)

Loads AbstractParameters from YAML

source

SimulationParameters.ystr2par — Function

ystr2par(yaml_string::String, par::AbstractParameters)

Loads AbstractParameters from YAML string

source

SimulationParameters.:↔ — Function

↔(x::Real, r::AbstractVector)

"leftrightarrow" unicode constructor for OptParameterRange

source

↔(x::Real, dist::Distributions.Distribution)

"leftrightarrow" unicode constructor for OptParameterDistribution

source

↔(x::Real, r::AbstractVector)

"leftrightarrow" unicode constructor for OptParameterChoice

source

↔(x::Real, r::AbstractVector)

"leftrightarrow" unicode constructor for OptParameterFunction

source