API Reference

• adjust
  • Multiply
    • Multiply.get_new_value()
  • Overwrite
    • Overwrite.get_new_value()
  • enforce_multiply()
  • enforce_wrapped()
• compartment
  • Compartment
    • Compartment.deserialize()
    • Compartment.has_name()
    • Compartment.has_name_in_list()
    • Compartment.has_strata()
    • Compartment.has_stratum()
    • Compartment.is_match()
    • Compartment.serialize()
    • Compartment.stratify()
• flows
  • CrudeBirthFlow
    • CrudeBirthFlow.get_net_flow()
  • DeathFlow
    • DeathFlow.get_net_flow()
    • DeathFlow.is_death_flow
  • ImportFlow
    • ImportFlow.get_net_flow()
  • InfectionDensityFlow
  • InfectionFrequencyFlow
  • ReplacementBirthFlow
    • ReplacementBirthFlow.get_net_flow()
  • TransitionFlow
    • TransitionFlow.get_net_flow()
  • WeightType
    • WeightType.FUNCTION
    • WeightType.STATIC
• model
  • BackendType
    • BackendType.JAX
    • BackendType.PYTHON
  • CompartmentalModel
    • CompartmentalModel.times
    • CompartmentalModel.compartments
    • CompartmentalModel.initial_population
    • CompartmentalModel.outputs
    • CompartmentalModel.derived_outputs
    • CompartmentalModel.add_computed_value_func()
    • CompartmentalModel.add_crude_birth_flow()
    • CompartmentalModel.add_death_flow()
    • CompartmentalModel.add_importation_flow()
    • CompartmentalModel.add_infection_density_flow()
    • CompartmentalModel.add_infection_frequency_flow()
    • CompartmentalModel.add_replacement_birth_flow()
    • CompartmentalModel.add_transition_flow()
    • CompartmentalModel.add_universal_death_flows()
    • CompartmentalModel.adjust_population_split()
    • CompartmentalModel.finalize()
    • CompartmentalModel.get_computed_value_keys()
    • CompartmentalModel.get_default_parameters()
    • CompartmentalModel.get_derived_outputs_df()
    • CompartmentalModel.get_epoch()
    • CompartmentalModel.get_initial_population()
    • CompartmentalModel.get_input_parameters()
    • CompartmentalModel.get_matching_compartments()
    • CompartmentalModel.get_object_graph()
    • CompartmentalModel.get_outputs_df()
    • CompartmentalModel.get_runner()
    • CompartmentalModel.get_stratification()
    • CompartmentalModel.init_population_with_graphobject()
    • CompartmentalModel.query_compartments()
    • CompartmentalModel.query_flows()
    • CompartmentalModel.request_aggregate_output()
    • CompartmentalModel.request_computed_value_output()
    • CompartmentalModel.request_cumulative_output()
    • CompartmentalModel.request_function_output()
    • CompartmentalModel.request_output_for_compartments()
    • CompartmentalModel.request_output_for_flow()
    • CompartmentalModel.request_track_modelled_value()
    • CompartmentalModel.run()
    • CompartmentalModel.set_baseline()
    • CompartmentalModel.set_default_parameters()
    • CompartmentalModel.set_derived_outputs_whitelist()
    • CompartmentalModel.set_initial_population()
    • CompartmentalModel.set_validation_enabled()
    • CompartmentalModel.stratify_with()
  • ModelResults
    • ModelResults.get_derived_outputs_df()
    • ModelResults.get_outputs_df()
    • ModelResults.run()
    • ModelResults.run_model()
• solver
  • SolverArgs
    • SolverArgs.DEFAULT
    • SolverArgs.FAST
    • SolverArgs.PRECISE
  • SolverType
    • SolverType.EULER
    • SolverType.ODE_INT
    • SolverType.RUNGE_KUTTA
    • SolverType.SOLVE_IVP
    • SolverType.STOCHASTIC
  • solve_ode()
  • solve_with_euler()
  • solve_with_ivp()
  • solve_with_odeint()
  • solve_with_rk4()
• stratification
  • AgeStratification
  • StrainStratification
  • Stratification
    • Stratification.add_infectiousness_adjustments()
    • Stratification.get_flow_adjustment()
    • Stratification.is_ageing()
    • Stratification.is_strain()
    • Stratification.set_flow_adjustments()
    • Stratification.set_mixing_matrix()
    • Stratification.set_population_split()
    • Stratification.validate_population_split()