Seapopym
Contents:
Examples
A simple 1D model implementation
Generating data for the 1D simulation
Initialize the model
Run the model
Plotting the results
The biomass evolution over time
And now let’s do it in parallel
The biomass evolution over time
Finaly, let’s try in weekly time step
Run the model
Plotting the results
Evolution of the 1D model implementation : with acidity
Generating data for the 1D simulation
Initialize the model
Run the model
Plotting the results
The biomass evolution over time
Light (memory) model
Generating data for the 1D simulation
Initialize the model
Run the model
Plotting the results
The biomass evolution over time
And now let’s do it in parallel
The biomass evolution over time
Finaly, let’s try in weekly time step
Run the model
Plotting the results
Zooplankton : LMTL vs SeapoPym (initial conditions)
Initialize the model
Let’s try with initial conditions
Micronekton Lower-mesopelagic : LMTL vs SeapoPym (initial conditions)
Initialize the model
Let’s try with initial conditions
seapopym
seapopym package
Subpackages
seapopym.configuration package
seapopym.core package
seapopym.function package
seapopym.logging package
seapopym.model package
seapopym.standard package
Module contents
Seapopym
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
|
Z
A
AbstractChunkParameter (class in seapopym.configuration.abstract_configuration)
AbstractClientParameter (class in seapopym.configuration.abstract_configuration)
AbstractConfiguration (class in seapopym.configuration.abstract_configuration)
AbstractEnvironmentParameter (class in seapopym.configuration.abstract_configuration)
AbstractForcingParameter (class in seapopym.configuration.abstract_configuration)
AbstractForcingUnit (class in seapopym.configuration.abstract_configuration)
AbstractFunctionalGroupParameter (class in seapopym.configuration.abstract_configuration)
AbstractFunctionalGroupUnit (class in seapopym.configuration.abstract_configuration)
AbstractFunctionalTypeParameter (class in seapopym.configuration.abstract_configuration)
AbstractKernelParameter (class in seapopym.configuration.abstract_configuration)
AbstractMigratoryTypeParameter (class in seapopym.configuration.abstract_configuration)
acidity (seapopym.configuration.acidity.forcing_parameter.ForcingParameter attribute)
(seapopym.standard.labels.ForcingLabels attribute)
(seapopym.standard.units.StandardUnitsLabels attribute)
AcidityConfiguration (class in seapopym.configuration.acidity.configuration)
AcidityModel (class in seapopym.model.acidity_model)
age_to_dataset() (seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupUnit method)
ageing() (in module seapopym.function.compiled_functions.production_compiled_functions)
all_forcings (seapopym.configuration.no_transport.forcing_parameter.ForcingParameter property)
angle_horizon_sun (seapopym.configuration.no_transport.kernel_parameter.KernelParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
apply_coefficient_to_primary_production_desc (in module seapopym.standard.attributs)
apply_mask_to_state() (in module seapopym.function.apply_mask_to_state)
are_all_instance_of_functional_group_unit() (seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupParameter method)
as_dict() (seapopym.configuration.no_transport.environment_parameter.ChunkParameter method)
attrs (seapopym.core.template.TemplateUnit attribute)
average_acidity() (in module seapopym.function.average_acidity)
average_temperature() (in module seapopym.function.average_temperature)
avg_acidity_by_fgroup (seapopym.standard.labels.ForcingLabels attribute)
avg_temperature_by_fgroup (seapopym.standard.labels.ForcingLabels attribute)
B
BaseModel (class in seapopym.model.base_model)
BaseTemplate (class in seapopym.core.template)
biomass (seapopym.standard.labels.ForcingLabels attribute)
(seapopym.standard.units.StandardUnitsLabels attribute)
biomass() (in module seapopym.function.biomass)
biomass_sequence() (in module seapopym.function.compiled_functions.biomass_compiled_functions)
C
cell_area (seapopym.standard.labels.ForcingLabels attribute)
cell_area() (in module seapopym.function.cell_area)
check_cohort_timestep() (seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupUnit method)
chunk (seapopym.configuration.abstract_configuration.AbstractEnvironmentParameter attribute)
(seapopym.configuration.no_transport.environment_parameter.EnvironmentParameter attribute)
ChunkParameter (class in seapopym.configuration.no_transport.environment_parameter)
chunks (seapopym.core.template.TemplateUnit attribute)
client (seapopym.configuration.abstract_configuration.AbstractClientParameter attribute)
cohort (seapopym.standard.labels.ConfigurationLabels attribute)
(seapopym.standard.labels.CoordinatesLabels attribute)
cohort_timestep (seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupUnit attribute)
compute_cell_area_desc (in module seapopym.standard.attributs)
compute_initial_conditions (seapopym.configuration.no_transport.kernel_parameter.KernelParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
compute_limits_from_zeu_lat_sst() (in module seapopym.function.limits)
compute_preproduction (seapopym.configuration.no_transport.kernel_parameter.KernelParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
ConfigurationLabels (class in seapopym.standard.labels)
convert() (seapopym.configuration.abstract_configuration.ParameterUnit method)
(seapopym.configuration.no_transport.forcing_parameter.ForcingUnit method)
CoordinatesLabels (class in seapopym.standard.labels)
D
day_layer (seapopym.configuration.no_transport.functional_group_parameter.MigratoryTypeParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
day_length (seapopym.standard.labels.ForcingLabels attribute)
day_length() (in module seapopym.function.day_length)
depth (seapopym.standard.labels.SeaLayers property)
dims (seapopym.core.template.TemplateUnit attribute)
dtype (seapopym.core.template.TemplateUnit attribute)
E
energy_transfert (seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupUnit attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
environment (seapopym.configuration.abstract_configuration.AbstractConfiguration attribute)
(seapopym.configuration.no_transport.configuration.NoTransportConfiguration attribute)
EnvironmentParameter (class in seapopym.configuration.no_transport.environment_parameter)
EPI (seapopym.standard.labels.SeaLayers attribute)
expand_dims() (in module seapopym.function.compiled_functions.production_compiled_functions)
expected_memory_usage (seapopym.model.no_transport_model.NoTransportModel property)
export_initial_conditions() (seapopym.model.no_transport_model.NoTransportModel method)
F
fgroup_name (seapopym.standard.labels.ConfigurationLabels attribute)
forcing (seapopym.configuration.abstract_configuration.AbstractConfiguration attribute)
(seapopym.configuration.abstract_configuration.AbstractForcingUnit attribute)
(seapopym.configuration.acidity.configuration.AcidityConfiguration attribute)
(seapopym.configuration.no_transport.configuration.NoTransportConfiguration attribute)
(seapopym.configuration.no_transport.forcing_parameter.ForcingUnit attribute)
ForcingAttrs (in module seapopym.standard.types)
ForcingLabels (class in seapopym.standard.labels)
ForcingName (in module seapopym.standard.types)
ForcingParameter (class in seapopym.configuration.acidity.forcing_parameter)
(class in seapopym.configuration.no_transport.forcing_parameter)
ForcingUnit (class in seapopym.configuration.no_transport.forcing_parameter)
from_configuration() (seapopym.model.acidity_model.AcidityModel class method)
(seapopym.model.base_model.BaseModel class method)
(seapopym.model.no_transport_model.NoTransportLightModel class method)
(seapopym.model.no_transport_model.NoTransportModel class method)
from_dataset() (seapopym.configuration.no_transport.forcing_parameter.ForcingUnit class method)
from_path() (seapopym.configuration.no_transport.forcing_parameter.ForcingUnit class method)
function (seapopym.core.kernel.KernelUnit attribute)
functional_group (seapopym.configuration.abstract_configuration.AbstractConfiguration attribute)
(seapopym.configuration.abstract_configuration.AbstractFunctionalGroupParameter attribute)
(seapopym.configuration.acidity.configuration.AcidityConfiguration attribute)
(seapopym.configuration.acidity.functional_group_parameter.FunctionalGroupParameter attribute)
(seapopym.configuration.no_transport.configuration.NoTransportConfiguration attribute)
(seapopym.configuration.no_transport.environment_parameter.ChunkParameter attribute)
(seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupParameter attribute)
(seapopym.standard.labels.CoordinatesLabels attribute)
functional_group_desc() (in module seapopym.standard.attributs)
functional_type (seapopym.configuration.abstract_configuration.AbstractFunctionalGroupUnit attribute)
(seapopym.configuration.acidity.functional_group_parameter.FunctionalGroupUnit attribute)
(seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupUnit attribute)
FunctionalGroupParameter (class in seapopym.configuration.acidity.functional_group_parameter)
(class in seapopym.configuration.no_transport.functional_group_parameter)
FunctionalGroupUnit (class in seapopym.configuration.acidity.functional_group_parameter)
(class in seapopym.configuration.no_transport.functional_group_parameter)
FunctionalTypeParameter (class in seapopym.configuration.acidity.functional_group_parameter)
(class in seapopym.configuration.no_transport.functional_group_parameter)
G
gamma_lambda_acidity (seapopym.configuration.acidity.functional_group_parameter.FunctionalTypeParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
gamma_lambda_temperature (seapopym.configuration.no_transport.functional_group_parameter.FunctionalTypeParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
gamma_tr (seapopym.configuration.no_transport.functional_group_parameter.FunctionalTypeParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
generate() (seapopym.core.template.BaseTemplate method)
(seapopym.core.template.Template method)
(seapopym.core.template.TemplateUnit method)
global_mask (seapopym.standard.labels.ForcingLabels attribute)
global_mask() (in module seapopym.function.global_mask)
global_mask_desc (in module seapopym.standard.attributs)
H
height (seapopym.standard.units.StandardUnitsLabels attribute)
I
initial_condition_biomass (seapopym.configuration.no_transport.forcing_parameter.ForcingParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
initial_condition_production (seapopym.configuration.no_transport.forcing_parameter.ForcingParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
K
Kernel (class in seapopym.core.kernel)
kernel (seapopym.configuration.abstract_configuration.AbstractConfiguration attribute)
(seapopym.configuration.no_transport.configuration.NoTransportConfiguration attribute)
(seapopym.model.base_model.BaseModel attribute)
kernel_factory() (in module seapopym.core.kernel)
kernel_unit_factory() (in module seapopym.core.kernel)
KernelParameter (class in seapopym.configuration.no_transport.kernel_parameter)
KernelUnit (class in seapopym.core.kernel)
L
lambda_acidity_0 (seapopym.configuration.acidity.functional_group_parameter.FunctionalTypeParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
lambda_temperature_0 (seapopym.configuration.no_transport.functional_group_parameter.FunctionalTypeParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
latitude (seapopym.configuration.no_transport.environment_parameter.ChunkParameter attribute)
list_available_dims() (in module seapopym.standard.coordinates)
longitude (seapopym.configuration.no_transport.environment_parameter.ChunkParameter attribute)
LOWMESO (seapopym.standard.labels.SeaLayers attribute)
M
mask_by_fgroup (seapopym.standard.labels.ForcingLabels attribute)
mask_by_fgroup() (in module seapopym.function.mask_by_functional_group)
mask_by_fgroup_desc (in module seapopym.standard.attributs)
mask_temperature (seapopym.standard.labels.ForcingLabels attribute)
mask_temperature() (in module seapopym.function.mask_temperature)
mask_temperature_desc (in module seapopym.standard.attributs)
max_timestep (seapopym.standard.labels.ConfigurationLabels attribute)
mean_timestep (seapopym.standard.labels.ConfigurationLabels attribute)
migratory_type (seapopym.configuration.abstract_configuration.AbstractFunctionalGroupUnit attribute)
(seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupUnit attribute)
MigratoryTypeParameter (class in seapopym.configuration.no_transport.functional_group_parameter)
min_temperature (seapopym.standard.labels.ForcingLabels attribute)
min_temperature_by_cohort() (in module seapopym.function.min_temperature)
min_temperature_by_cohort_desc (in module seapopym.standard.attributs)
min_timestep (seapopym.standard.labels.ConfigurationLabels attribute)
module
seapopym
seapopym.configuration
seapopym.configuration.abstract_configuration
seapopym.configuration.acidity
seapopym.configuration.acidity.configuration
seapopym.configuration.acidity.forcing_parameter
seapopym.configuration.acidity.functional_group_parameter
seapopym.configuration.no_transport
seapopym.configuration.no_transport.configuration
seapopym.configuration.no_transport.environment_parameter
seapopym.configuration.no_transport.forcing_parameter
seapopym.configuration.no_transport.functional_group_parameter
seapopym.configuration.no_transport.kernel_parameter
seapopym.core
seapopym.core.kernel
seapopym.core.template
seapopym.function
seapopym.function.apply_coefficient_to_primary_production
seapopym.function.apply_mask_to_state
seapopym.function.average_acidity
seapopym.function.average_temperature
seapopym.function.biomass
seapopym.function.cell_area
seapopym.function.compiled_functions
seapopym.function.compiled_functions.biomass_compiled_functions
seapopym.function.compiled_functions.production_compiled_functions
seapopym.function.day_length
seapopym.function.global_mask
seapopym.function.limits
seapopym.function.mask_by_functional_group
seapopym.function.mask_temperature
seapopym.function.min_temperature
seapopym.function.mortality_acidity_field
seapopym.function.mortality_field
seapopym.function.production
seapopym.model
seapopym.model.acidity_model
seapopym.model.base_model
seapopym.model.no_transport_model
seapopym.standard
seapopym.standard.attributs
seapopym.standard.coordinates
seapopym.standard.labels
seapopym.standard.types
seapopym.standard.units
mortality_acidity_field() (in module seapopym.function.mortality_acidity_field)
mortality_field (seapopym.standard.labels.ForcingLabels attribute)
mortality_field() (in module seapopym.function.mortality_field)
mortality_field_desc (in module seapopym.standard.attributs)
N
name (seapopym.configuration.abstract_configuration.AbstractFunctionalGroupUnit attribute)
(seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupUnit attribute)
(seapopym.core.kernel.KernelUnit attribute)
(seapopym.core.template.TemplateUnit attribute)
new_cohort() (in module seapopym.standard.coordinates)
new_latitude() (in module seapopym.standard.coordinates)
new_layer() (in module seapopym.standard.coordinates)
new_longitude() (in module seapopym.standard.coordinates)
new_time() (in module seapopym.standard.coordinates)
night_layer (seapopym.configuration.no_transport.functional_group_parameter.MigratoryTypeParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
NoTransportConfiguration (class in seapopym.configuration.no_transport.configuration)
NoTransportLightModel (class in seapopym.model.no_transport_model)
NoTransportModel (class in seapopym.model.no_transport_model)
O
order_data() (seapopym.standard.labels.CoordinatesLabels class method)
ordered() (seapopym.standard.labels.CoordinatesLabels class method)
P
parameter_to_dataset (seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupUnit attribute)
ParameterUnit (class in seapopym.configuration.abstract_configuration)
parse() (seapopym.configuration.abstract_configuration.AbstractConfiguration class method)
(seapopym.configuration.no_transport.configuration.NoTransportConfiguration class method)
path_validation() (in module seapopym.configuration.no_transport.forcing_parameter)
preproduction (seapopym.standard.labels.ForcingLabels attribute)
primary_production (seapopym.configuration.no_transport.forcing_parameter.ForcingParameter attribute)
(seapopym.standard.labels.ForcingLabels attribute)
primary_production_by_fgroup (seapopym.standard.labels.ForcingLabels attribute)
primary_production_by_fgroup() (in module seapopym.function.apply_coefficient_to_primary_production)
production (seapopym.standard.units.StandardUnitsLabels attribute)
production() (in module seapopym.function.compiled_functions.production_compiled_functions)
(in module seapopym.function.production)
production_export_initial() (in module seapopym.function.compiled_functions.production_compiled_functions)
production_export_preproduction() (in module seapopym.function.compiled_functions.production_compiled_functions)
production_initial_condition() (in module seapopym.function.production)
production_unrecruited() (in module seapopym.function.production)
Q
quantity (seapopym.configuration.abstract_configuration.ParameterUnit property)
R
recruited (seapopym.standard.labels.ForcingLabels attribute)
reorder_dims() (in module seapopym.standard.coordinates)
resolution_latitude (seapopym.standard.labels.ConfigurationLabels attribute)
resolution_longitude (seapopym.standard.labels.ConfigurationLabels attribute)
run() (seapopym.core.kernel.Kernel method)
(seapopym.core.kernel.KernelUnit method)
(seapopym.model.base_model.BaseModel method)
(seapopym.model.no_transport_model.NoTransportModel method)
S
SeaLayers (class in seapopym.standard.labels)
seapopym
module
seapopym.configuration
module
seapopym.configuration.abstract_configuration
module
seapopym.configuration.acidity
module
seapopym.configuration.acidity.configuration
module
seapopym.configuration.acidity.forcing_parameter
module
seapopym.configuration.acidity.functional_group_parameter
module
seapopym.configuration.no_transport
module
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
seapopym.core
module
seapopym.core.kernel
module
seapopym.core.template
module
seapopym.function
module
seapopym.function.apply_coefficient_to_primary_production
module
seapopym.function.apply_mask_to_state
module
seapopym.function.average_acidity
module
seapopym.function.average_temperature
module
seapopym.function.biomass
module
seapopym.function.cell_area
module
seapopym.function.compiled_functions
module
seapopym.function.compiled_functions.biomass_compiled_functions
module
seapopym.function.compiled_functions.production_compiled_functions
module
seapopym.function.day_length
module
seapopym.function.global_mask
module
seapopym.function.limits
module
seapopym.function.mask_by_functional_group
module
seapopym.function.mask_temperature
module
seapopym.function.min_temperature
module
seapopym.function.mortality_acidity_field
module
seapopym.function.mortality_field
module
seapopym.function.production
module
seapopym.model
module
seapopym.model.acidity_model
module
seapopym.model.base_model
module
seapopym.model.no_transport_model
module
seapopym.standard
module
seapopym.standard.attributs
module
seapopym.standard.coordinates
module
seapopym.standard.labels
module
seapopym.standard.types
module
seapopym.standard.units
module
SeapopymDims (in module seapopym.standard.types)
SeapopymForcing (in module seapopym.standard.types)
SeapopymState (in module seapopym.standard.types)
standard_name (seapopym.standard.labels.SeaLayers property)
StandardUnitsLabels (class in seapopym.standard.units)
state (seapopym.configuration.abstract_configuration.AbstractConfiguration property)
(seapopym.configuration.no_transport.configuration.NoTransportConfiguration property)
(seapopym.model.base_model.BaseModel attribute)
T
temperature (seapopym.configuration.no_transport.forcing_parameter.ForcingParameter attribute)
(seapopym.standard.labels.ForcingLabels attribute)
(seapopym.standard.units.StandardUnitsLabels attribute)
Template (class in seapopym.core.template)
template (seapopym.core.kernel.KernelUnit attribute)
(seapopym.model.no_transport_model.NoTransportModel property)
template() (seapopym.core.kernel.Kernel method)
template_unit (seapopym.core.template.Template attribute)
template_unit_factory() (in module seapopym.core.template)
TemplateUnit (class in seapopym.core.template)
time (seapopym.configuration.no_transport.environment_parameter.ChunkParameter attribute)
(seapopym.standard.labels.CoordinatesLabels attribute)
(seapopym.standard.units.StandardUnitsLabels attribute)
time_loop() (in module seapopym.function.compiled_functions.production_compiled_functions)
timestep (seapopym.configuration.abstract_configuration.AbstractForcingParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
timesteps_number (seapopym.standard.labels.ConfigurationLabels attribute)
to_dataset() (seapopym.configuration.abstract_configuration.AbstractForcingParameter method)
(seapopym.configuration.abstract_configuration.AbstractFunctionalGroupParameter method)
(seapopym.configuration.abstract_configuration.AbstractFunctionalGroupUnit method)
(seapopym.configuration.no_transport.forcing_parameter.ForcingParameter method)
(seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupParameter method)
(seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupUnit method)
(seapopym.configuration.no_transport.kernel_parameter.KernelParameter method)
to_remove_from_state (seapopym.core.kernel.KernelUnit attribute)
tr_0 (seapopym.configuration.no_transport.functional_group_parameter.FunctionalTypeParameter attribute)
(seapopym.standard.labels.ConfigurationLabels attribute)
U
unit (seapopym.configuration.abstract_configuration.ParameterUnit attribute)
units (seapopym.standard.units.StandardUnitsLabels property)
update_cohort_timestep() (seapopym.configuration.no_transport.functional_group_parameter.FunctionalGroupUnit method)
UPMESO (seapopym.standard.labels.SeaLayers attribute)
V
value (seapopym.configuration.abstract_configuration.ParameterUnit attribute)
verify_init() (in module seapopym.configuration.no_transport.forcing_parameter)
(in module seapopym.configuration.no_transport.functional_group_parameter)
W
weight (seapopym.standard.units.StandardUnitsLabels attribute)
X
X (seapopym.standard.labels.CoordinatesLabels attribute)
Y
Y (seapopym.standard.labels.CoordinatesLabels attribute)
Z
Z (seapopym.standard.labels.CoordinatesLabels attribute)