.. |AdHocModel.run| replace:: :func:`~hydpy.core.modeltools.AdHocModel.run`
.. |AdHocModel| replace:: :class:`~hydpy.core.modeltools.AdHocModel`
.. |ELSModel.calculate_error| replace:: :func:`~hydpy.core.modeltools.ELSModel.calculate_error`
.. |ELSModel.extrapolate_error| replace:: :func:`~hydpy.core.modeltools.ELSModel.extrapolate_error`
.. |ELSModel.solve| replace:: :func:`~hydpy.core.modeltools.ELSModel.solve`
.. |ELSModel| replace:: :class:`~hydpy.core.modeltools.ELSModel`
.. |Element.collective| replace:: :attr:`~hydpy.core.devicetools.Element.collective`
.. |Element.model| replace:: :const:`~hydpy.core.devicetools.Element.model`
.. |Elements.unite_collectives| replace:: :func:`~hydpy.core.devicetools.Elements.unite_collectives`
.. |Elements| replace:: :class:`~hydpy.core.devicetools.Elements`
.. |Element| replace:: :class:`~hydpy.core.devicetools.Element`
.. |FactorSequence| replace:: :class:`~hydpy.core.sequencetools.FactorSequence`
.. |False| replace:: :const:`False`
.. |FileManager.currentdir| replace:: :const:`~hydpy.core.filetools.FileManager.currentdir`
.. |FluxSequence| replace:: :class:`~hydpy.core.sequencetools.FluxSequence`
.. |FusedVariable| replace:: :class:`~hydpy.core.devicetools.FusedVariable`
.. |HydPy.conditions| replace:: :const:`~hydpy.core.hydpytools.HydPy.conditions`
.. |HydPy.load_conditions| replace:: :func:`~hydpy.core.hydpytools.HydPy.load_conditions`
.. |HydPy.save_controls| replace:: :func:`~hydpy.core.hydpytools.HydPy.save_controls`
.. |HydPy.simulate| replace:: :func:`~hydpy.core.hydpytools.HydPy.simulate`
.. |HydPy| replace:: :class:`~hydpy.core.hydpytools.HydPy`
.. |IOSequence.load_series| replace:: :func:`~hydpy.core.sequencetools.IOSequence.load_series`
.. |IOSequence.prepare_series| replace:: :func:`~hydpy.core.sequencetools.IOSequence.prepare_series`
.. |IOSequence.save_series| replace:: :func:`~hydpy.core.sequencetools.IOSequence.save_series`
.. |Idx_Sim| replace:: :class:`~hydpy.core.modeltools.Idx_Sim`
.. |IndexProperty| replace:: :class:`~hydpy.core.modeltools.IndexProperty`
.. |InputSequence| replace:: :class:`~hydpy.core.sequencetools.InputSequence`
.. |LinkSequence| replace:: :class:`~hydpy.core.sequencetools.LinkSequence`
.. |LogSequence| replace:: :class:`~hydpy.core.sequencetools.LogSequence`
.. |Masks| replace:: :class:`~hydpy.core.masktools.Masks`
.. |Method| replace:: :class:`~hydpy.core.modeltools.Method`
.. |Model.connect| replace:: :func:`~hydpy.core.modeltools.Model.connect`
.. |Model.define_conditions| replace:: :func:`~hydpy.core.modeltools.Model.define_conditions`
.. |Model.find_submodels| replace:: :func:`~hydpy.core.modeltools.Model.find_submodels`
.. |Model.get_controlfileheader| replace:: :func:`~hydpy.core.modeltools.Model.get_controlfileheader`
.. |Model.get_methods| replace:: :func:`~hydpy.core.modeltools.Model.get_methods`
.. |Model.load_conditions| replace:: :func:`~hydpy.core.modeltools.Model.load_conditions`
.. |Model.load_factorseries| replace:: :func:`~hydpy.core.modeltools.Model.load_factorseries`
.. |Model.load_fluxseries| replace:: :func:`~hydpy.core.modeltools.Model.load_fluxseries`
.. |Model.load_inputseries| replace:: :func:`~hydpy.core.modeltools.Model.load_inputseries`
.. |Model.load_stateseries| replace:: :func:`~hydpy.core.modeltools.Model.load_stateseries`
.. |Model.name| replace:: :const:`~hydpy.core.modeltools.Model.name`
.. |Model.prepare_factorseries| replace:: :func:`~hydpy.core.modeltools.Model.prepare_factorseries`
.. |Model.prepare_fluxseries| replace:: :func:`~hydpy.core.modeltools.Model.prepare_fluxseries`
.. |Model.prepare_inputseries| replace:: :func:`~hydpy.core.modeltools.Model.prepare_inputseries`
.. |Model.prepare_stateseries| replace:: :func:`~hydpy.core.modeltools.Model.prepare_stateseries`
.. |Model.save_conditions| replace:: :func:`~hydpy.core.modeltools.Model.save_conditions`
.. |Model.save_controls| replace:: :func:`~hydpy.core.modeltools.Model.save_controls`
.. |Model.save_data| replace:: :func:`~hydpy.core.modeltools.Model.save_data`
.. |Model.save_factorseries| replace:: :func:`~hydpy.core.modeltools.Model.save_factorseries`
.. |Model.save_fluxseries| replace:: :func:`~hydpy.core.modeltools.Model.save_fluxseries`
.. |Model.save_inputseries| replace:: :func:`~hydpy.core.modeltools.Model.save_inputseries`
.. |Model.save_stateseries| replace:: :func:`~hydpy.core.modeltools.Model.save_stateseries`
.. |Model.sequences| replace:: :attr:`~hydpy.core.modeltools.Model.sequences`
.. |Model.simulate| replace:: :func:`~hydpy.core.modeltools.Model.simulate`
.. |Model.update_parameters| replace:: :func:`~hydpy.core.modeltools.Model.update_parameters`
.. |Model.update_receivers| replace:: :func:`~hydpy.core.modeltools.Model.update_receivers`
.. |Model.update_senders| replace:: :func:`~hydpy.core.modeltools.Model.update_senders`
.. |ModelCoupler| replace:: :class:`~hydpy.core.modeltools.ModelCoupler`
.. |Model| replace:: :class:`~hydpy.core.modeltools.Model`
.. |NodeSequence| replace:: :class:`~hydpy.core.sequencetools.NodeSequence`
.. |Nodes| replace:: :class:`~hydpy.core.devicetools.Nodes`
.. |Node| replace:: :class:`~hydpy.core.devicetools.Node`
.. |None| replace:: :const:`None`
.. |NumVarsELS| replace:: :class:`~hydpy.core.modeltools.NumVarsELS`
.. |OutputSequence| replace:: :class:`~hydpy.core.sequencetools.OutputSequence`
.. |Parameters.update| replace:: :func:`~hydpy.core.parametertools.Parameters.update`
.. |Parameters| replace:: :class:`~hydpy.core.parametertools.Parameters`
.. |Parameter| replace:: :class:`~hydpy.core.parametertools.Parameter`
.. |ReceiverSequence| replace:: :class:`~hydpy.core.sequencetools.ReceiverSequence`
.. |ReusableMethod.REUSEMARKER| replace:: :attr:`~hydpy.core.modeltools.ReusableMethod.REUSEMARKER`
.. |ReusableMethod| replace:: :class:`~hydpy.core.modeltools.ReusableMethod`
.. |RunModel.RUN_METHODS| replace:: :attr:`~hydpy.core.modeltools.RunModel.RUN_METHODS`
.. |RuntimeError| replace:: :class:`RuntimeError`
.. |SegmentModel.idx_segment| replace:: :const:`~hydpy.core.modeltools.SegmentModel.idx_segment`
.. |SegmentModel.run_segments| replace:: :func:`~hydpy.core.modeltools.SegmentModel.run_segments`
.. |SegmentModel| replace:: :class:`~hydpy.core.modeltools.SegmentModel`
.. |Selection| replace:: :class:`~hydpy.core.selectiontools.Selection`
.. |Sequences.load_data| replace:: :func:`~hydpy.core.sequencetools.Sequences.load_data`
.. |Sequences.reset| replace:: :func:`~hydpy.core.sequencetools.Sequences.reset`
.. |Sequences.save_data| replace:: :func:`~hydpy.core.sequencetools.Sequences.save_data`
.. |Sequences.trim_conditions| replace:: :func:`~hydpy.core.sequencetools.Sequences.trim_conditions`
.. |Sequences.update_outputs| replace:: :func:`~hydpy.core.sequencetools.Sequences.update_outputs`
.. |Sequences| replace:: :class:`~hydpy.core.sequencetools.Sequences`
.. |SetAutoMethod| replace:: :class:`~hydpy.core.modeltools.SetAutoMethod`
.. |SharableSubmodelInterface| replace:: :class:`~hydpy.core.modeltools.SharableSubmodelInterface`
.. |SolverParameter| replace:: :class:`~hydpy.core.parametertools.SolverParameter`
.. |StateSequences.new2old| replace:: :func:`~hydpy.core.sequencetools.StateSequences.new2old`
.. |StateSequence| replace:: :class:`~hydpy.core.sequencetools.StateSequence`
.. |SubParameters| replace:: :class:`~hydpy.core.parametertools.SubParameters`
.. |SubmodelAdder| replace:: :class:`~hydpy.core.importtools.SubmodelAdder`
.. |SubmodelInterface.add_mainmodel_as_subsubmodel| replace:: :func:`~hydpy.core.modeltools.SubmodelInterface.add_mainmodel_as_subsubmodel`
.. |SubmodelInterface.share_configuration| replace:: :func:`~hydpy.core.modeltools.SubmodelInterface.share_configuration`
.. |SubmodelInterface.typeid| replace:: :attr:`~hydpy.core.modeltools.SubmodelInterface.typeid`
.. |SubmodelInterface| replace:: :class:`~hydpy.core.modeltools.SubmodelInterface`
.. |SubmodelIsMainmodelProperty| replace:: :class:`~hydpy.core.modeltools.SubmodelIsMainmodelProperty`
.. |SubmodelProperty| replace:: :class:`~hydpy.core.modeltools.SubmodelProperty`
.. |SubmodelTypeIDProperty| replace:: :class:`~hydpy.core.modeltools.SubmodelTypeIDProperty`
.. |SubmodelsProperty.append_submodel| replace:: :func:`~hydpy.core.modeltools.SubmodelsProperty.append_submodel`
.. |SubmodelsProperty.delete_submodel| replace:: :func:`~hydpy.core.modeltools.SubmodelsProperty.delete_submodel`
.. |SubmodelsProperty.number| replace:: :const:`~hydpy.core.modeltools.SubmodelsProperty.number`
.. |SubmodelsProperty.put_submodel| replace:: :func:`~hydpy.core.modeltools.SubmodelsProperty.put_submodel`
.. |SubmodelsProperty.submodels| replace:: :const:`~hydpy.core.modeltools.SubmodelsProperty.submodels`
.. |SubmodelsProperty.typeids| replace:: :const:`~hydpy.core.modeltools.SubmodelsProperty.typeids`
.. |SubmodelsProperty| replace:: :class:`~hydpy.core.modeltools.SubmodelsProperty`
.. |Submodel| replace:: :class:`~hydpy.core.modeltools.Submodel`
.. |SubstepModel.run| replace:: :func:`~hydpy.core.modeltools.SubstepModel.run`
.. |SubstepModel.timeleft| replace:: :const:`~hydpy.core.modeltools.SubstepModel.timeleft`
.. |True| replace:: :const:`True`
.. |Variable.average_values| replace:: :func:`~hydpy.core.variabletools.Variable.average_values`
.. |abstractmodelmethod| replace:: :func:`~hydpy.core.modeltools.abstractmodelmethod`
.. |controlcheck| replace:: :func:`~hydpy.core.importtools.controlcheck`
.. |dam_pump| replace:: :mod:`~hydpy.models.dam_pump`
.. |define_modelcoupler| replace:: :func:`~hydpy.core.modeltools.define_modelcoupler`
.. |evap_aet_hbv96| replace:: :mod:`~hydpy.models.evap_aet_hbv96`
.. |evap_aet_morsim| replace:: :mod:`~hydpy.models.evap_aet_morsim`
.. |evap_pet_hbv96| replace:: :mod:`~hydpy.models.evap_pet_hbv96`
.. |hland_96| replace:: :mod:`~hydpy.models.hland_96`
.. |isinstance| replace:: :func:`isinstance`
.. |lland_knauf| replace:: :mod:`~hydpy.models.lland_knauf`
.. |meteo_glob_fao56| replace:: :mod:`~hydpy.models.meteo_glob_fao56`
.. |musk_classic| replace:: :mod:`~hydpy.models.musk_classic`
.. |musk_mct| replace:: :mod:`~hydpy.models.musk_mct`
.. |parameterstep| replace:: :func:`~hydpy.core.importtools.parameterstep`
.. |prepare_model| replace:: :func:`~hydpy.core.importtools.prepare_model`
.. |pub| replace:: :mod:`~hydpy.pub`
.. |roottools| replace:: :mod:`~hydpy.auxs.roottools`
.. |smoothtools| replace:: :mod:`~hydpy.auxs.smoothtools`
.. |sw1d_channel| replace:: :mod:`~hydpy.models.sw1d_channel`
.. |test_discontinous| replace:: :mod:`~hydpy.models.test_discontinous`
.. |test_stiff0d| replace:: :mod:`~hydpy.models.test_stiff0d`
.. |abc.abstractmethod| replace:: :func:`~abc.abstractmethod`
.. |dam_factors.WaterLevel| replace:: :class:`~hydpy.models.dam.dam_factors.WaterLevel`
.. |dam_receivers.OWL| replace:: :class:`~hydpy.models.dam.dam_receivers.OWL`
.. |dam_receivers.RWL| replace:: :class:`~hydpy.models.dam.dam_receivers.RWL`
.. |evap_control.Soil| replace:: :class:`~hydpy.models.evap.evap_control.Soil`
.. |evap_derived.Altitude| replace:: :class:`~hydpy.models.evap.evap_derived.Altitude`
.. |hland_constants.FIELD| replace:: :const:`~hydpy.models.hland.hland_constants.FIELD`
.. |hland_constants.FOREST| replace:: :const:`~hydpy.models.hland.hland_constants.FOREST`
.. |hland_constants.ILAKE| replace:: :const:`~hydpy.models.hland.hland_constants.ILAKE`
.. |hland_control.ZoneZ| replace:: :class:`~hydpy.models.hland.hland_control.ZoneZ`
.. |hland_derived.Z| replace:: :class:`~hydpy.models.hland.hland_derived.Z`
.. |hland_fluxes.PC| replace:: :class:`~hydpy.models.hland.hland_fluxes.PC`
.. |hland_fluxes.Q0| replace:: :class:`~hydpy.models.hland.hland_fluxes.Q0`
.. |hland_inputs.P| replace:: :class:`~hydpy.models.hland.hland_inputs.P`
.. |hland_inputs.T| replace:: :class:`~hydpy.models.hland.hland_inputs.T`
.. |hland_states.SM| replace:: :class:`~hydpy.models.hland.hland_states.SM`
.. |hland_states.UZ| replace:: :class:`~hydpy.models.hland.hland_states.UZ`
.. |modeltools.Idx_Sim| replace:: :class:`~hydpy.core.modeltools.Idx_Sim`
.. |musk_model.Calc_Discharge_V1| replace:: :class:`~hydpy.models.musk.musk_model.Calc_Discharge_V1`
.. |numpy.nan| replace:: :const:`~numpy.nan`
.. |test_control.K| replace:: :class:`~hydpy.models.test.test_control.K`
.. |test_fluxes.Q| replace:: :class:`~hydpy.models.test.test_fluxes.Q`
.. |test_solver.AbsErrorMax| replace:: :class:`~hydpy.models.test.test_solver.AbsErrorMax`
.. |test_solver.RelDTMax| replace:: :class:`~hydpy.models.test.test_solver.RelDTMax`
.. |test_solver.RelDTMin| replace:: :class:`~hydpy.models.test.test_solver.RelDTMin`
.. |test_solver.RelErrorMax| replace:: :class:`~hydpy.models.test.test_solver.RelErrorMax`
.. |test_states.S| replace:: :class:`~hydpy.models.test.test_states.S`

.. _modeltools:

modeltools
==========

.. automodule:: hydpy.core.modeltools
    :members:
    :show-inheritance:
    :exclude-members: Union, AsyncIterable, CONTROLPARAMETERS, TypeAliasType, NotRequired, ADD_METHODS, RESULTSEQUENCES, Protocol, reveal_type, MutableSet, Concatenate, REQUIREDSEQUENCES, SupportsFloat, MutableSequence, SOLVERSEQUENCES, assert_never, NamedTuple, Text, Coroutine, ValuesView, FrozenSet, evaluate_forward_ref, SUBMODELINTERFACES, get_args, get_origin, ForwardRef, INTERFACE_METHODS, Annotated, Mapping, TypeForm, is_protocol, ChainMap, Iterator, TypeGuard, SUBMETHODS, runtime, ParamSpecArgs, SUBMODELS, TypedDict, KeysView, OUTLET_METHODS, Collection, Sequence, CapsuleType, Generator, NoReturn, ParamSpec, TextIO, AsyncContextManager, ContextManager, ParamSpecKwargs, assert_type, UPDATEDSEQUENCES, SupportsIndex, get_annotations, dataclass_transform, no_type_check_decorator, ClassVar, AsyncGenerator, Buffer, TypeIs, SupportsAbs, Match, FULL_ODE_METHODS, Sized, Never, is_typeddict, get_original_bases, TypeVarTuple, no_type_check, FIXEDPARAMETERS, DefaultDict, get_type_hints, NewType, fastaccess_old, Literal, TypeVar, runtime_checkable, ByteString, Format, Deque, Final, deprecated, final, Callable, SENDER_METHODS, Generic, AsyncIterator, Any, RECEIVER_METHODS, fastaccess_new, cast, MappingView, DERIVEDPARAMETERS, Counter, subseqs, List, SupportsComplex, OrderedDict, CLASSES, Unpack, Awaitable, MutableMapping, INLET_METHODS, IntVar, Set, RUN_METHODS, subpars, overload, Doc, Optional, Iterable, AbstractSet, NoExtraItems, TypeAlias, get_protocol_members, ReadOnly, clear_overloads, Type, BinaryIO, Pattern, fastaccess, Container, Hashable, NoDefault, PART_ODE_METHODS, LiteralString, SupportsInt, Self, SupportsBytes, SupportsRound, Dict, SOLVERPARAMETERS, Reversible, pars, Required, Tuple, ItemsView, override, get_overloads, IO, subvars, TYPE_CHECKING, seqs, AnyStr