seapopym package

Subpackages

• seapopym.configuration package
  • Subpackages
    • seapopym.configuration.acidity package
      • Submodules
      • seapopym.configuration.acidity.configuration module
      • seapopym.configuration.acidity.forcing_parameter module
      • seapopym.configuration.acidity.functional_group_parameter module
      • Module contents
    • seapopym.configuration.no_transport package
      • Submodules
      • seapopym.configuration.no_transport.configuration module
      • seapopym.configuration.no_transport.environment_parameter module
      • seapopym.configuration.no_transport.forcing_parameter module
      • seapopym.configuration.no_transport.functional_group_parameter module
      • seapopym.configuration.no_transport.kernel_parameter module
      • Module contents
  • Submodules
  • seapopym.configuration.abstract_configuration module
    • AbstractChunkParameter
    • AbstractClientParameter
      • AbstractClientParameter.client
    • AbstractConfiguration
      • AbstractConfiguration.environment
      • AbstractConfiguration.forcing
      • AbstractConfiguration.functional_group
      • AbstractConfiguration.kernel
      • AbstractConfiguration.parse()
      • AbstractConfiguration.state
    • AbstractEnvironmentParameter
      • AbstractEnvironmentParameter.chunk
    • AbstractForcingParameter
      • AbstractForcingParameter.timestep
      • AbstractForcingParameter.to_dataset()
    • AbstractForcingUnit
      • AbstractForcingUnit.forcing
    • AbstractFunctionalGroupParameter
      • AbstractFunctionalGroupParameter.functional_group
      • AbstractFunctionalGroupParameter.to_dataset()
    • AbstractFunctionalGroupUnit
      • AbstractFunctionalGroupUnit.functional_type
      • AbstractFunctionalGroupUnit.migratory_type
      • AbstractFunctionalGroupUnit.name
      • AbstractFunctionalGroupUnit.to_dataset()
    • AbstractFunctionalTypeParameter
    • AbstractKernelParameter
    • AbstractMigratoryTypeParameter
    • ParameterUnit
      • ParameterUnit.convert()
      • ParameterUnit.quantity
      • ParameterUnit.unit
      • ParameterUnit.value
  • Module contents
• seapopym.core package
  • Submodules
  • seapopym.core.kernel module
    • Kernel
      • Kernel.run()
      • Kernel.template()
    • KernelUnit
      • KernelUnit.function
      • KernelUnit.name
      • KernelUnit.run()
      • KernelUnit.template
      • KernelUnit.to_remove_from_state
    • kernel_factory()
    • kernel_unit_factory()
  • seapopym.core.template module
    • Notes
    • BaseTemplate
      • BaseTemplate.generate()
    • Template
      • Template.generate()
      • Template.template_unit
    • TemplateUnit
      • TemplateUnit.attrs
      • TemplateUnit.chunks
      • TemplateUnit.dims
      • TemplateUnit.dtype
      • TemplateUnit.generate()
      • TemplateUnit.name
    • template_unit_factory()
  • Module contents
• seapopym.function package
  • Subpackages
    • seapopym.function.compiled_functions package
      • Submodules
      • seapopym.function.compiled_functions.biomass_compiled_functions module
      • seapopym.function.compiled_functions.production_compiled_functions module
      • Module contents
  • Submodules
  • seapopym.function.apply_coefficient_to_primary_production module
    • primary_production_by_fgroup()
  • seapopym.function.apply_mask_to_state module
    • apply_mask_to_state()
  • seapopym.function.average_acidity module
    • average_acidity()
  • seapopym.function.average_temperature module
    • average_temperature()
  • seapopym.function.biomass module
    • biomass()
  • seapopym.function.cell_area module
    • cell_area()
  • seapopym.function.day_length module
    • day_length()
  • seapopym.function.global_mask module
    • global_mask()
  • seapopym.function.limits module
    • compute_limits_from_zeu_lat_sst()
  • seapopym.function.mask_by_functional_group module
    • mask_by_fgroup()
  • seapopym.function.mask_temperature module
    • mask_temperature()
  • seapopym.function.min_temperature module
    • min_temperature_by_cohort()
  • seapopym.function.mortality_acidity_field module
    • mortality_acidity_field()
  • seapopym.function.mortality_field module
    • mortality_field()
  • seapopym.function.production module
    • production()
    • production_initial_condition()
    • production_unrecruited()
  • Module contents
• seapopym.logging package
  • Submodules
  • seapopym.logging.custom_logger module
  • Module contents
• seapopym.model package
  • Submodules
  • seapopym.model.acidity_model module
    • AcidityModel
      • AcidityModel.from_configuration()
  • seapopym.model.base_model module
    • BaseModel
      • BaseModel.from_configuration()
      • BaseModel.kernel
      • BaseModel.run()
      • BaseModel.state
  • seapopym.model.no_transport_model module
    • NoTransportLightModel
      • NoTransportLightModel.from_configuration()
    • NoTransportModel
      • NoTransportModel.expected_memory_usage
      • NoTransportModel.export_initial_conditions()
      • NoTransportModel.from_configuration()
      • NoTransportModel.run()
      • NoTransportModel.template
  • Module contents
• seapopym.standard package
  • Submodules
  • seapopym.standard.attributs module
    • apply_coefficient_to_primary_production_desc
    • compute_cell_area_desc
    • functional_group_desc()
    • global_mask_desc
    • mask_by_fgroup_desc
    • mask_temperature_desc
    • min_temperature_by_cohort_desc
    • mortality_field_desc
  • seapopym.standard.coordinates module
    • list_available_dims()
    • new_cohort()
    • new_latitude()
    • new_layer()
    • new_longitude()
    • new_time()
    • reorder_dims()
  • seapopym.standard.labels module
    • ConfigurationLabels
      • ConfigurationLabels.angle_horizon_sun
      • ConfigurationLabels.cohort
      • ConfigurationLabels.compute_initial_conditions
      • ConfigurationLabels.compute_preproduction
      • ConfigurationLabels.day_layer
      • ConfigurationLabels.energy_transfert
      • ConfigurationLabels.fgroup_name
      • ConfigurationLabels.gamma_lambda_acidity
      • ConfigurationLabels.gamma_lambda_temperature
      • ConfigurationLabels.gamma_tr
      • ConfigurationLabels.initial_condition_biomass
      • ConfigurationLabels.initial_condition_production
      • ConfigurationLabels.lambda_acidity_0
      • ConfigurationLabels.lambda_temperature_0
      • ConfigurationLabels.max_timestep
      • ConfigurationLabels.mean_timestep
      • ConfigurationLabels.min_timestep
      • ConfigurationLabels.night_layer
      • ConfigurationLabels.resolution_latitude
      • ConfigurationLabels.resolution_longitude
      • ConfigurationLabels.timestep
      • ConfigurationLabels.timesteps_number
      • ConfigurationLabels.tr_0
    • CoordinatesLabels
      • CoordinatesLabels.X
      • CoordinatesLabels.Y
      • CoordinatesLabels.Z
      • CoordinatesLabels.cohort
      • CoordinatesLabels.functional_group
      • CoordinatesLabels.order_data()
      • CoordinatesLabels.ordered()
      • CoordinatesLabels.time
    • ForcingLabels
      • ForcingLabels.acidity
      • ForcingLabels.avg_acidity_by_fgroup
      • ForcingLabels.avg_temperature_by_fgroup
      • ForcingLabels.biomass
      • ForcingLabels.cell_area
      • ForcingLabels.day_length
      • ForcingLabels.global_mask
      • ForcingLabels.mask_by_fgroup
      • ForcingLabels.mask_temperature
      • ForcingLabels.min_temperature
      • ForcingLabels.mortality_field
      • ForcingLabels.preproduction
      • ForcingLabels.primary_production
      • ForcingLabels.primary_production_by_fgroup
      • ForcingLabels.recruited
      • ForcingLabels.temperature
    • SeaLayers
      • SeaLayers.EPI
      • SeaLayers.LOWMESO
      • SeaLayers.UPMESO
      • SeaLayers.depth
      • SeaLayers.standard_name
  • seapopym.standard.types module
    • ForcingAttrs
    • ForcingName
    • SeapopymDims
    • SeapopymForcing
    • SeapopymState
  • seapopym.standard.units module
    • StandardUnitsLabels
      • StandardUnitsLabels.acidity
      • StandardUnitsLabels.biomass
      • StandardUnitsLabels.height
      • StandardUnitsLabels.production
      • StandardUnitsLabels.temperature
      • StandardUnitsLabels.time
      • StandardUnitsLabels.units
      • StandardUnitsLabels.weight
  • Module contents

Module contents