From e45a87ad1f7d77837b2c211f1a944fc9e108a472 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Sun, 3 Nov 2024 18:46:18 +0000 Subject: [PATCH] build based on 68d1509 --- dev/.documenter-siteinfo.json | 2 +- dev/api/index.html | 2 +- dev/index.html | 2 +- dev/license/index.html | 2 +- dev/notice/index.html | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 4eadbb8..e659ad0 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-01T21:17:26","documenter_version":"1.7.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-03T18:46:13","documenter_version":"1.7.0"}} \ No newline at end of file diff --git a/dev/api/index.html b/dev/api/index.html index 5b5210a..d71432c 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -3,4 +3,4 @@ function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-65D8V8C8VQ', {'page_path': location.pathname + location.search + location.hash}); -
GitHub

API Reference

SimulationParameters

Missing docstring.

Missing docstring for AbstractParameter. 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.

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.

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.

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.par2json — Function
par2json(@nospecialize(par::AbstractParameters), filename::String; kw...)

Save AbstractParameters to JSON

NOTE: kw arguments are passed to JSON.print

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.

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.:↔ — Function
↔(x::Real, r::AbstractVector)

"leftrightarrow" unicode constructor for OptParameterRange

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

"leftrightarrow" unicode constructor for OptParameterChoice

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

"leftrightarrow" unicode constructor for OptParameterFunction

source
+
GitHub

API Reference

SimulationParameters

Missing docstring.

Missing docstring for AbstractParameter. 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.

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.

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.

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.par2json — Function
par2json(@nospecialize(par::AbstractParameters), filename::String; kw...)

Save AbstractParameters to JSON

NOTE: kw arguments are passed to JSON.print

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.

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.:↔ — Function
↔(x::Real, r::AbstractVector)

"leftrightarrow" unicode constructor for OptParameterRange

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

"leftrightarrow" unicode constructor for OptParameterChoice

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

"leftrightarrow" unicode constructor for OptParameterFunction

source
diff --git a/dev/index.html b/dev/index.html index 1b5c4d5..cc031d4 100644 --- a/dev/index.html +++ b/dev/index.html @@ -3,4 +3,4 @@ function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-65D8V8C8VQ', {'page_path': location.pathname + location.search + location.hash}); -
GitHub

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 SwitchOptions

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.

Docs

+
GitHub

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 SwitchOptions

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.

Docs

diff --git a/dev/license/index.html b/dev/license/index.html index 86ca1d2..d15310f 100644 --- a/dev/license/index.html +++ b/dev/license/index.html @@ -12,4 +12,4 @@ comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier - identification within third-party archives.

Copyright 2024 General Atomics

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

+ identification within third-party archives.

Copyright 2024 General Atomics

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

diff --git a/dev/notice/index.html b/dev/notice/index.html index 57bb8fc..b81368b 100644 --- a/dev/notice/index.html +++ b/dev/notice/index.html @@ -9,4 +9,4 @@ journal = {arXiv}, title = {{FUSE (Fusion Synthesis Engine): A Next Generation Framework for Integrated Design of Fusion Pilot Plants}}, year = {2024} -}

Trademark Notice

The names "General Atomics", and any associated logos or images, are trademarks of General Atomics. Use of these trademarks without prior written consent from General Atomics is strictly prohibited. Users cannot imply endorsement by General Atomics or contributors to the project simply because the project is part of their work.

Copyright (c) 2024 General Atomics

Version

Version: v2.1

+}

Trademark Notice

The names "General Atomics", and any associated logos or images, are trademarks of General Atomics. Use of these trademarks without prior written consent from General Atomics is strictly prohibited. Users cannot imply endorsement by General Atomics or contributors to the project simply because the project is part of their work.

Copyright (c) 2024 General Atomics

Version

Version: v2.1