Sindbad.Types Module

Types

The Types module consolidates and organizes all the types used in the SINDBAD framework into a central location. This ensures a single source for type definitions, promoting consistency and reusability across all SINDBAD packages. It also provides helper functions and utilities for working with these types.

Purpose

This module serves as the backbone for type definitions in SINDBAD, ensuring modularity and extensibility. It provides a unified hierarchy for SINDBAD-specific types and includes utilities for introspection, type manipulation, and documentation.

Dependencies

External (third-party)

• InteractiveUtils: Interactive exploration and debugging helpers.

• Base.Docs: Documentation utilities for type introspection.

Included Files

• LandTypes.jl: Types for land variables and land/array structures used during model execution.

• ArrayTypes.jl: Specialized array types for efficient data handling.

• InputTypes.jl: Types for input data/configuration (forcing/observation metadata and wiring).

• SimulationTypes.jl: Types representing simulation setup/configuration and results.

• ParameterOptimizationTypes.jl: Types for optimization workflows (algorithms, options, cost hooks).

• MachineLearningTypes.jl: Types supporting machine-learning workflows and data structures.

Notes

• The Types module serves as the backbone for type definitions in SINDBAD, ensuring modularity and extensibility.

• Each type is documented with its purpose via the purpose function, making it easier for developers to understand and extend the framework.

• The SindbadTypes abstract type serves as the base for all Julia types in the SINDBAD framework.

Examples

1. Querying type purpose:

using Sindbad.Types
purpose(BayesOptKMaternARD5)  # Returns the purpose string for the type

1. Working with SINDBAD types:

using Sindbad.Types
# All SINDBAD types are available through this module

source

Functions

Types

ActivationType

Missing docstring.

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

---

AllForwardModels

Missing docstring.

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

---

ArrayTypes

Missing docstring.

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

---

ArrayView

Sindbad.Types.ArrayView Type

ArrayView{T,N,S<:AbstractArray{<:Any,N}}

Fields:

• s::S: The underlying array being viewed.

• groupname::Symbol: The name of the group containing the array.

• arrayname::Symbol: The name of the array being accessed.

source

---

BackendNetcdf

Missing docstring.

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

---

BackendZarr

Missing docstring.

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

---

BayesOptKMaternARD5

Missing docstring.

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

---

CMAEvolutionStrategyCMAES

Missing docstring.

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

---

CalcFoldFromSplit

Missing docstring.

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

---

ConcatData

Missing docstring.

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

---

CostMethod

Missing docstring.

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

---

CostModelObs

Missing docstring.

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

---

CostModelObsLandTS

Missing docstring.

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

---

CostModelObsMT

Missing docstring.

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

---

CostModelObsPriors

Missing docstring.

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

---

CustomSigmoid

Missing docstring.

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

---

DataAggrOrder

Missing docstring.

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

---

DataFormatBackend

Missing docstring.

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

---

DoAggrObs

Missing docstring.

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

---

DoCalcCost

Missing docstring.

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

---

DoFilterNanPixels

Missing docstring.

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

---

DoNotAggrObs

Missing docstring.

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

---

DoNotCalcCost

Missing docstring.

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

---

DoNotFilterNanPixels

Missing docstring.

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

---

DoNotOutputAll

Missing docstring.

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

---

DoNotRunForward

Missing docstring.

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

---

DoNotRunOptimization

Missing docstring.

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

---

DoNotSaveInfo

Missing docstring.

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

---

DoNotSaveSingleFile

Missing docstring.

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

---

DoNotSpatialWeight

Missing docstring.

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

---

DoNotSpinupTEM

Missing docstring.

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

---

DoNotStoreSpinup

Missing docstring.

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

---

DoNotUseForwardDiff

Missing docstring.

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

---

DoOutputAll

Missing docstring.

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

---

DoRunForward

Missing docstring.

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

---

DoRunOptimization

Missing docstring.

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

---

DoSaveInfo

Missing docstring.

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

---

DoSaveSingleFile

Missing docstring.

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

---

DoSpatialWeight

Missing docstring.

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

---

DoSpinupTEM

Missing docstring.

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

---

DoStoreSpinup

Missing docstring.

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

---

DoUseForwardDiff

Missing docstring.

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

---

EnzymeGrad

Missing docstring.

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

---

EtaScaleA0H

Missing docstring.

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

---

EtaScaleA0HCWD

Missing docstring.

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

---

EtaScaleAH

Missing docstring.

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

---

EtaScaleAHCWD

Missing docstring.

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

---

EvolutionaryCMAES

Missing docstring.

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

---

FiniteDiffGrad

Missing docstring.

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

---

FiniteDifferencesGrad

Missing docstring.

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

---

FluxDenseNN

Missing docstring.

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

---

FluxRelu

Missing docstring.

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

---

FluxSigmoid

Missing docstring.

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

---

FluxTanh

Missing docstring.

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

---

FluxnetParameterLearningWROASTED

Missing docstring.

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

---

ForcingWithTime

Missing docstring.

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

---

ForcingWithoutTime

Missing docstring.

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

---

ForwardDiffGrad

Missing docstring.

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

---

GSAMethod

Missing docstring.

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

---

GSAMorris

Missing docstring.

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

---

GSASobol

Missing docstring.

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

---

GSASobolDM

Missing docstring.

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

---

GroupView

Sindbad.Types.GroupView Type

GroupView{S}

Fields:

• groupname::Symbol: The name of the group being accessed.

• s::S: The underlying data structure containing the group.

source

---

InputArray

Missing docstring.

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

---

InputArrayBackend

Missing docstring.

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

---

InputKeyedArray

Missing docstring.

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

---

InputNamedDimsArray

Missing docstring.

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

---

InputTypes

Missing docstring.

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

---

InputYaxArray

Missing docstring.

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

---

LandTypes

Missing docstring.

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

---

LandWrapper

Sindbad.Types.LandWrapper Type

LandWrapper{S}

Fields:

• s::S: The underlying NamedTuple or data structure being wrapped.

source

---

LoadFoldFromFile

Missing docstring.

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

---

LossModelObsMachineLearning

Missing docstring.

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

---

MachineLearningExperimentType

Missing docstring.

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

---

MachineLearningGradType

Missing docstring.

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

---

MachineLearningModelType

Missing docstring.

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

---

MachineLearningOptimizerType

Missing docstring.

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

---

MachineLearningPullbackType

Missing docstring.

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

---

MachineLearningTrainingType

Missing docstring.

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

---

MachineLearningTypes

Missing docstring.

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

---

MachineLearningUpdateType

Missing docstring.

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

---

MetricMaximum

Missing docstring.

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

---

MetricMinimum

Missing docstring.

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

---

MetricSpatial

Missing docstring.

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

---

MetricSum

Missing docstring.

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

---

MixedGradient

Missing docstring.

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

---

ModelArrayArray

Missing docstring.

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

---

ModelArrayStaticArray

Missing docstring.

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

---

ModelArrayType

Missing docstring.

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

---

ModelArrayView

Missing docstring.

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

---

NlsolveFixedpointTrustregionCEco

Missing docstring.

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

---

NlsolveFixedpointTrustregionCEcoTWS

Missing docstring.

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

---

NlsolveFixedpointTrustregionTWS

Missing docstring.

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

---

ODEAutoTsit5Rodas5

Missing docstring.

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

---

ODEDP5

Missing docstring.

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

---

ODETsit5

Missing docstring.

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

---

OptimBFGS

Missing docstring.

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

---

OptimLBFGS

Missing docstring.

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

---

OptimisersAdam

Missing docstring.

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

---

OptimisersDescent

Missing docstring.

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

---

OptimisersUpdate

Missing docstring.

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

---

OptimizationBBOadaptive

Missing docstring.

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

---

OptimizationBBOxnes

Missing docstring.

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

---

OptimizationBFGS

Missing docstring.

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

---

OptimizationFminboxGradientDescent

Missing docstring.

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

---

OptimizationFminboxGradientDescentFD

Missing docstring.

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

---

OptimizationGCMAESDef

Missing docstring.

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

---

OptimizationGCMAESFD

Missing docstring.

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

---

OptimizationMultistartOptimization

Missing docstring.

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

---

OptimizationNelderMead

Missing docstring.

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

---

OptimizationQuadDirect

Missing docstring.

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

---

OutputArray

Missing docstring.

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

---

OutputArrayType

Missing docstring.

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

---

OutputMArray

Missing docstring.

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

---

OutputSizedArray

Missing docstring.

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

---

OutputStrategy

Missing docstring.

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

---

OutputYAXArray

Missing docstring.

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

---

ParallelizationPackage

Missing docstring.

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

---

ParameterOptimizationMethod

Missing docstring.

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

---

ParameterOptimizationTypes

Missing docstring.

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

---

ParameterScaling

Missing docstring.

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

---

PolyesterForwardDiffGrad

Missing docstring.

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

---

PreAlloc

Missing docstring.

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

---

PreAllocArray

Missing docstring.

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

---

PreAllocArrayAll

Missing docstring.

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

---

PreAllocArrayFD

Missing docstring.

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

---

PreAllocArrayMT

Missing docstring.

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

---

PreAllocStacked

Missing docstring.

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

---

PreAllocTimeseries

Missing docstring.

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

---

PreAllocYAXArray

Missing docstring.

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

---

QbmapParallelization

Missing docstring.

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

---

RunFlag

Missing docstring.

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

---

SSPDynamicSSTsit5

Missing docstring.

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

---

SSPSSRootfind

Missing docstring.

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

---

ScaleBounds

Missing docstring.

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

---

ScaleDefault

Missing docstring.

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

---

ScaleNone

Missing docstring.

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

---

SelSpinupModels

Missing docstring.

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

---

SimulationTypes

Missing docstring.

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

---

SpaceID

Missing docstring.

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

---

SpaceId

Missing docstring.

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

---

SpaceTime

Missing docstring.

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

---

Spaceid

Missing docstring.

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

---

Spacelat

Missing docstring.

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

---

Spacelatitude

Missing docstring.

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

---

Spacelon

Missing docstring.

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

---

Spacelongitude

Missing docstring.

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

---

Spacesite

Missing docstring.

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

---

SpatialDataAggr

Missing docstring.

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

---

SpatialMetricAggr

Missing docstring.

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

---

SpatialSubsetter

Missing docstring.

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

---

SpinupMode

Missing docstring.

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

---

SpinupSequence

Missing docstring.

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

---

SpinupSequenceWithAggregator

Missing docstring.

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

---

SpinupTypes

Missing docstring.

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

---

Spinup_TWS

Sindbad.Types.Spinup_TWS Type

(TWS_spin::Spinup_TWS)(pout, p)

Custom callable type function for spinning up TWS pools.

Arguments

• pout: Output pools

• p: Input pools

Note

This method allows a Spinup_TWS object to be called as a function, implementing the specific spinup logic for the terrestrial water storage components.

source

---

Spinup_cEco

Sindbad.Types.Spinup_cEco Type

(cEco_spin::Spinup_cEco)(pout, p)

Custom callable type function for spinning up cEco.

Arguments

• pout: Output pools

• p: Input pools

Note

This method allows a Spinup_cEco object to be called as a function, implementing the specific spinup logic for ecosystem carbon pools.

source

---

Spinup_cEco_TWS

Sindbad.Types.Spinup_cEco_TWS Type

(cEco_TWS_spin::Spinup_cEco_TWS)(pout, p)

Custom callable type function for spinning up cEco and TWS pools.

Arguments

• pout: Output pools

• p: Input pools

Note

This method allows a Spinup_cEco_TWS object to be called as a function, implementing the specific spinup logic for ecosystem carbon pools and the terrestrial water storage components.

source

---

ThreadsParallelization

Missing docstring.

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

---

TimeSpace

Missing docstring.

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

---

ZygoteGrad

Missing docstring.

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

---

ZygotePullback

Missing docstring.

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

---