2PhotosynthesisModel Plugin for PyHelios.
4This module provides a high-level interface to the Helios photosynthesis modeling
5plugin, enabling simulation of plant photosynthesis processes using both empirical
9from typing
import List, Optional, Union
10from .Context
import Context
11from .wrappers
import UPhotosynthesisWrapper
as photosynthesis_wrapper
12from .types.photosynthesis
import (
13 PhotosyntheticTemperatureResponseParameters,
14 EmpiricalModelCoefficients,
15 FarquharModelCoefficients,
16 PHOTOSYNTHESIS_SPECIES,
17 validate_species_name,
18 get_available_species,
21from .validation.plugin_decorators
import (
22 validate_photosynthesis_species_params,
23 validate_empirical_model_params,
24 validate_farquhar_model_params,
25 validate_photosynthesis_uuid_params
30 """Exception raised by PhotosynthesisModel operations."""
37AVAILABLE_C4_SPECIES = [
38 "SetariaViridis_vC2021",
46 High-level interface for Helios photosynthesis modeling.
48 The PhotosynthesisModel provides methods for configuring and running
49 photosynthesis simulations using various models including empirical
50 and mechanistic (Farquhar-von Caemmerer-Berry) approaches.
53 - Support for empirical and FvCB photosynthesis models
54 - Built-in species library with 21+ plant species
55 - Comprehensive parameter validation
56 - Context manager support for proper cleanup
59 >>> from pyhelios import Context, PhotosynthesisModel
60 >>> from pyhelios.types import EmpiricalModelCoefficients
61 >>> context = Context()
62 >>> with PhotosynthesisModel(context) as photosynthesis:
63 ... # Configure empirical model
64 ... coeffs = EmpiricalModelCoefficients(
65 ... Tref=298.0, # Reference temperature (K)
66 ... Ci_ref=290.0, # Reference CO2 concentration (μmol/mol)
67 ... Asat=20.0, # Light-saturated photosynthesis rate (μmol/m²/s)
68 ... theta=65.0 # Light response curvature (W/m²)
70 ... photosynthesis.setEmpiricalModelCoefficients(coeffs)
71 ... photosynthesis.run()
73 Available species can be queried using:
74 >>> PhotosynthesisModel.get_available_species()
75 ['ALMOND', 'APPLE', 'AVOCADO', ...]
78 def __init__(self, context: Context):
80 Initialize PhotosynthesisModel.
83 context: PyHelios Context instance containing the 3D geometry
86 PhotosynthesisModelError: If plugin is not available or initialization fails
88 if not isinstance(context, Context):
90 f
"Context parameter must be a Context instance, got {type(context).__name__}"
98 context_ptr = self.
context.getNativePtr()
99 if context_ptr
is None:
103 self.
_native_ptr = photosynthesis_wrapper.createPhotosynthesisModel(context_ptr)
107 except Exception
as e:
108 if "photosynthesis plugin is not available" in str(e).lower():
110 "Photosynthesis plugin is not available. "
111 "Please rebuild PyHelios with photosynthesis plugin enabled:\n"
112 " build_scripts/build_helios --plugins photosynthesis"
114 elif "mock mode" in str(e).lower():
116 "PhotosynthesisModel requires native Helios libraries. "
117 "Currently running in mock mode. Please build native libraries:\n"
118 " build_scripts/build_helios --plugins photosynthesis"
124 """Context manager entry."""
127 def __exit__(self, exc_type, exc_value, traceback):
128 """Context manager exit with cleanup."""
132 """Clean up native resources."""
133 if hasattr(self,
'_native_ptr')
and self.
_native_ptr is not None:
135 photosynthesis_wrapper.destroyPhotosynthesisModel(self.
_native_ptr)
142 """Get the native C++ pointer for advanced operations."""
146 """Destructor to ensure cleanup."""
152 Set the photosynthesis model type to empirical.
154 The empirical model uses light response curves with saturation kinetics.
156 photosynthesis_wrapper.setModelTypeEmpirical(self.
_native_ptr)
160 Set the photosynthesis model type to Farquhar-von Caemmerer-Berry.
162 The FvCB model is a mechanistic model accounting for biochemical
163 limitations of C3 photosynthesis.
165 photosynthesis_wrapper.setModelTypeFarquhar(self.
_native_ptr)
169 Set the photosynthesis model type to the von Caemmerer (2021) steady-state C4 model.
171 Pair with :meth:`setC4CoefficientsFromLibrary` (e.g. ``"SetariaViridis_vC2021"``,
172 ``"Maize_Massad2007"``) or :meth:`setC4ModelCoefficients` to populate parameters.
175 Requires helios-core v1.3.72 or newer.
178 NotImplementedError: If running against an older helios-core that does not
179 support the C4 bindings — rebuild with ``build_scripts/build_helios --clean``.
181 photosynthesis_wrapper.setModelTypeC4(self.
_native_ptr)
187 uuids: Optional[List[int]] =
None):
189 Set Farquhar mesophyll conductance ``gm`` (mol CO2 / m² / s / bar) for selected primitives.
191 Pass ``dha`` < 0 (the default) to apply ``gm`` with no temperature response. Pass a
192 positive ``dha`` and leave ``topt``/``dhd`` at -1 to use a monotonic Arrhenius response.
193 Set ``topt`` (in °C) for a peaked Arrhenius response, and ``dhd`` to override the
194 deactivation energy (defaults to ``10*dha``).
197 gm_at_25c: ``gm`` at the 25 °C reference, mol CO2 / m² / s / bar.
198 dha: Activation energy (kJ/mol). -1 disables temperature response.
199 topt: Optimum temperature in °C. -1 keeps Arrhenius monotonic.
200 dhd: Deactivation energy (kJ/mol). -1 picks a default.
201 uuids: Primitive UUIDs to update. ``None`` is rejected; the underlying
202 wrapper requires explicit UUIDs (matching ``setVcmax`` etc.).
205 ValueError: If ``uuids`` is None or empty.
206 NotImplementedError: If running against helios-core older than v1.3.72.
210 "setFarquharMesophyllConductance requires explicit UUIDs. "
211 "To configure all primitives use setFarquharModelCoefficients() with a populated coefficient set."
213 photosynthesis_wrapper.setFarquharMesophyllConductance(
214 self.
_native_ptr, gm_at_25c, dha, topt, dhd, uuids,
218 material_label: Optional[str] =
None):
220 Set C4 model coefficients from the von Caemmerer (2021) species library.
223 species: Species name (case-insensitive). See :data:`AVAILABLE_C4_SPECIES`.
224 uuids: Optional list of primitive UUIDs. If None and ``material_label`` is
225 also None, applies to all primitives in the Context.
226 material_label: Optional material label. When set, applies the coefficients
227 to every primitive that references this material at run() time. Mutually
228 exclusive with ``uuids``.
231 ValueError: If both ``uuids`` and ``material_label`` are provided.
232 NotImplementedError: If running against helios-core older than v1.3.72.
234 if uuids
is not None and material_label
is not None:
235 raise ValueError(
"setC4CoefficientsFromLibrary: pass either uuids or material_label, not both.")
236 if material_label
is not None:
237 photosynthesis_wrapper.setC4CoefficientsFromLibraryForMaterial(
241 photosynthesis_wrapper.setC4CoefficientsFromLibrary(self.
_native_ptr, species, uuids)
245 Return the 43-float C4 coefficient array for ``species``.
247 See ``native/include/pyhelios_wrapper_photosynthesis.h`` for the per-index meaning.
249 return photosynthesis_wrapper.getC4CoefficientsFromLibrary(self.
_native_ptr, species)
252 uuids: Optional[List[int]] =
None,
253 material_label: Optional[str] =
None):
255 Apply a 43-float C4 coefficient array.
257 Pair with :meth:`getC4CoefficientsFromLibrary` to round-trip a species' defaults.
260 coefficients: 43-float C4 coefficient array.
261 uuids: Optional list of primitive UUIDs. If None and ``material_label`` is
262 also None, applies to all primitives in the Context.
263 material_label: Optional material label. When set, applies the coefficients
264 to every primitive that references this material at run() time. Mutually
265 exclusive with ``uuids``.
268 ValueError: If both ``uuids`` and ``material_label`` are provided.
270 if uuids
is not None and material_label
is not None:
271 raise ValueError(
"setC4ModelCoefficients: pass either uuids or material_label, not both.")
272 if material_label
is not None:
273 photosynthesis_wrapper.setC4ModelCoefficientsForMaterial(
277 photosynthesis_wrapper.setC4ModelCoefficients(self.
_native_ptr, coefficients, uuids)
280 """Return the 43-float C4 coefficient array for a single primitive."""
281 return photosynthesis_wrapper.getC4ModelCoefficients(self.
_native_ptr, uuid)
283 def setCm(self, cm: float, uuids: List[int]):
285 Manually prescribe the mesophyll cytosolic CO2 partial pressure (Cm) for the C4 model.
287 Bypasses the ``Cm = Ci - A/gm`` fixed-point iteration and the stomatal balance
288 on Ci. Primarily intended for testing and validation against the von Caemmerer 2021
289 reference spreadsheet.
292 cm: Mesophyll cytosolic CO2 partial pressure in ubar.
293 uuids: Primitive UUIDs to set. Must be non-empty.
296 ValueError: If ``uuids`` is empty.
297 NotImplementedError: If running against helios-core older than v1.3.72.
300 raise ValueError(
"setCm requires a non-empty list of UUIDs.")
301 photosynthesis_wrapper.setCm(self.
_native_ptr, cm, uuids)
306 Run photosynthesis calculations for all primitives in the context.
308 The model must be configured with appropriate coefficients before running.
312 @validate_photosynthesis_uuid_params
315 Run photosynthesis calculations for specific primitives.
318 uuids: Single UUID (integer) or list of UUIDs for primitives
320 if isinstance(uuids, int):
322 photosynthesis_wrapper.runForUUIDs(self.
_native_ptr, uuids)
325 @validate_photosynthesis_species_params
328 Set Farquhar model coefficients from built-in species library.
331 species: Species name from the built-in library
332 uuids: Optional list of primitive UUIDs. If None, applies to all primitives.
335 >>> model.setSpeciesCoefficients("APPLE")
336 >>> model.setSpeciesCoefficients("SOYBEAN", [uuid1, uuid2])
339 photosynthesis_wrapper.setFarquharCoefficientsFromLibrary(self.
_native_ptr, species)
341 photosynthesis_wrapper.setFarquharCoefficientsFromLibraryForUUIDs(self.
_native_ptr, species, uuids)
345 Set Farquhar model coefficients from built-in species library.
347 This method matches the C++ API naming: setFarquharCoefficientsFromLibrary()
350 species: Species name from the built-in library
351 uuids: Optional list of primitive UUIDs. If None, applies to all primitives.
354 >>> model.setFarquharCoefficientsFromLibrary("APPLE")
355 >>> model.setFarquharCoefficientsFromLibrary("SOYBEAN", [uuid1, uuid2])
358 photosynthesis_wrapper.setFarquharCoefficientsFromLibrary(self.
_native_ptr, species)
360 photosynthesis_wrapper.setFarquharCoefficientsFromLibraryForUUIDs(self.
_native_ptr, species, uuids)
364 Get Farquhar model coefficients for a species from the library.
367 species: Species name
370 List of Farquhar model coefficients for the species
372 species = validate_species_name(species)
373 return photosynthesis_wrapper.getFarquharCoefficientsFromLibrary(self.
_native_ptr, species)
378 Static method to get available species without creating a model instance.
381 List of species names available in the photosynthesis library
388 Static method to get species aliases mapping.
391 Dictionary mapping aliases to canonical species names
396 @validate_empirical_model_params
398 uuids: Optional[List[int]] =
None):
400 Set empirical model coefficients.
403 coefficients: EmpiricalModelCoefficients instance with model parameters
404 uuids: Optional list of primitive UUIDs. If None, applies to all primitives.
407 coeff_list = coefficients.to_array()
410 photosynthesis_wrapper.setEmpiricalModelCoefficients(self.
_native_ptr, coeff_list)
412 photosynthesis_wrapper.setEmpiricalModelCoefficientsForUUIDs(self.
_native_ptr, coeff_list, uuids)
414 @validate_farquhar_model_params
416 uuids: Optional[List[int]] =
None):
418 Set Farquhar model coefficients.
421 coefficients: FarquharModelCoefficients instance with FvCB parameters
422 uuids: Optional list of primitive UUIDs. If None, applies to all primitives.
425 coeff_list = coefficients.to_array()
428 photosynthesis_wrapper.setFarquharModelCoefficients(self.
_native_ptr, coeff_list)
430 photosynthesis_wrapper.setFarquharModelCoefficientsForUUIDs(self.
_native_ptr, coeff_list, uuids)
433 def setVcmax(self, vcmax: float, uuids: List[int], dha: Optional[float] =
None,
434 topt: Optional[float] =
None, dhd: Optional[float] =
None):
436 Set maximum carboxylation rate for Farquhar model.
438 This method modifies only the Vcmax parameter while preserving all
439 other existing Farquhar model parameters for each primitive.
442 vcmax: Maximum carboxylation rate at 25°C (μmol m⁻² s⁻¹)
443 uuids: List of primitive UUIDs to modify (required)
444 dha: Activation energy (optional, kJ/mol)
445 topt: Optimal temperature (optional, °C)
446 dhd: Deactivation energy (optional, kJ/mol)
449 Primitives must have existing Farquhar model coefficients set before
450 calling this method. Use setFarquharCoefficientsFromLibrary() first
451 if needed. To modify all primitives, use setFarquharModelCoefficients()
452 with complete coefficient objects.
454 from .types
import FarquharModelCoefficients
462 existing_coeffs = FarquharModelCoefficients.from_array(existing_array)
466 existing_coeffs.Vcmax = vcmax
469 from .types
import PhotosyntheticTemperatureResponseParameters
470 if dhd
is None and topt
is None:
478 existing_coeffs.Vcmax = temp_response.value_at_25C
481 existing_coeffs.Vcmax = vcmax
486 def setJmax(self, jmax: float, uuids: List[int], dha: Optional[float] =
None,
487 topt: Optional[float] =
None, dhd: Optional[float] =
None):
489 Set maximum electron transport rate for Farquhar model.
491 This method modifies only the Jmax parameter while preserving all
492 other existing Farquhar model parameters for each primitive.
495 jmax: Maximum electron transport rate at 25°C (μmol m⁻² s⁻¹)
496 uuids: List of primitive UUIDs to modify (required)
497 dha: Activation energy (optional, kJ/mol)
498 topt: Optimal temperature (optional, °C)
499 dhd: Deactivation energy (optional, kJ/mol)
502 Primitives must have existing Farquhar model coefficients set before
503 calling this method. Use setFarquharCoefficientsFromLibrary() first
504 if needed. To modify all primitives, use setFarquharModelCoefficients()
505 with complete coefficient objects.
507 from .types
import FarquharModelCoefficients
515 existing_coeffs = FarquharModelCoefficients.from_array(existing_array)
518 existing_coeffs.Jmax = jmax
523 def setDarkRespiration(self, respiration: float, uuids: List[int], dha: Optional[float] =
None,
524 topt: Optional[float] =
None, dhd: Optional[float] =
None):
526 Set dark respiration rate.
528 This method modifies only the Rd parameter while preserving all
529 other existing Farquhar model parameters for each primitive.
532 respiration: Dark respiration rate at 25°C (μmol m⁻² s⁻¹)
533 uuids: List of primitive UUIDs to modify (required)
534 dha: Activation energy (optional, kJ/mol)
535 topt: Optimal temperature (optional, °C)
536 dhd: Deactivation energy (optional, kJ/mol)
539 Primitives must have existing Farquhar model coefficients set before
540 calling this method. Use setFarquharCoefficientsFromLibrary() first
541 if needed. To modify all primitives, use setFarquharModelCoefficients()
542 with complete coefficient objects.
544 from .types
import FarquharModelCoefficients
552 existing_coeffs = FarquharModelCoefficients.from_array(existing_array)
555 existing_coeffs.Rd = respiration
560 def setQuantumEfficiency(self, efficiency: float, uuids: List[int], dha: Optional[float] =
None,
561 topt: Optional[float] =
None, dhd: Optional[float] =
None):
563 Set quantum efficiency of photosystem II.
565 This method modifies only the alpha parameter while preserving all
566 other existing Farquhar model parameters for each primitive.
569 efficiency: Quantum efficiency at 25°C (dimensionless, 0-1)
570 uuids: List of primitive UUIDs to modify (required)
571 dha: Activation energy (optional, kJ/mol)
572 topt: Optimal temperature (optional, °C)
573 dhd: Deactivation energy (optional, kJ/mol)
576 Primitives must have existing Farquhar model coefficients set before
577 calling this method. Use setFarquharCoefficientsFromLibrary() first
578 if needed. To modify all primitives, use setFarquharModelCoefficients()
579 with complete coefficient objects.
581 from .types
import FarquharModelCoefficients
589 existing_coeffs = FarquharModelCoefficients.from_array(existing_array)
592 existing_coeffs.alpha = efficiency
598 topt: Optional[float] =
None, dhd: Optional[float] =
None):
600 Set light response curvature parameter.
602 This method modifies only the theta parameter while preserving all
603 other existing Farquhar model parameters for each primitive.
606 curvature: Light response curvature at 25°C (dimensionless)
607 uuids: List of primitive UUIDs to modify (required)
608 dha: Activation energy (optional, kJ/mol)
609 topt: Optimal temperature (optional, °C)
610 dhd: Deactivation energy (optional, kJ/mol)
613 Primitives must have existing Farquhar model coefficients set before
614 calling this method. Use setFarquharCoefficientsFromLibrary() first
615 if needed. To modify all primitives, use setFarquharModelCoefficients()
616 with complete coefficient objects.
619 The theta parameter is stored in the coefficient array but may not be
620 directly exposed in the current FarquharModelCoefficients structure.
621 This method sets the basic curvature value.
623 from .types
import FarquharModelCoefficients
631 existing_coeffs = FarquharModelCoefficients.from_array(existing_array)
643 Get empirical model coefficients for a specific primitive.
649 List of empirical model coefficients
651 return photosynthesis_wrapper.getEmpiricalModelCoefficients(self.
_native_ptr, uuid)
655 Get Farquhar model coefficients for a specific primitive.
661 List of Farquhar model coefficients
663 return photosynthesis_wrapper.getFarquharModelCoefficients(self.
_native_ptr, uuid)
667 Export photosynthesis results with optional label.
670 label: Data label for export
672 photosynthesis_wrapper.optionalOutputPrimitiveData(self.
_native_ptr, label)
676 """Enable photosynthesis model status messages."""
677 photosynthesis_wrapper.enableMessages(self.
_native_ptr)
680 """Disable photosynthesis model status messages."""
681 photosynthesis_wrapper.disableMessages(self.
_native_ptr)
685 Print model configuration report.
688 uuids: Optional list of UUIDs. If None, prints report for all primitives.
691 photosynthesis_wrapper.printDefaultValueReport(self.
_native_ptr)
693 photosynthesis_wrapper.printDefaultValueReportForUUIDs(self.
_native_ptr, uuids)
698 Basic validation that model has been configured.
701 True if model appears to be configured (has native pointer)
707 Reset the model by recreating it.
708 Note: This will clear all configured parameters.
713 context_ptr = self.
context.getNativePtr()
714 self.
_native_ptr = photosynthesis_wrapper.createPhotosynthesisModel(context_ptr)
718 photosynthesis_wrapper.destroyPhotosynthesisModel(old_ptr)
Exception raised by PhotosynthesisModel operations.
High-level interface for Helios photosynthesis modeling.
setC4CoefficientsFromLibrary(self, str species, Optional[List[int]] uuids=None, Optional[str] material_label=None)
Set C4 model coefficients from the von Caemmerer (2021) species library.
disableMessages(self)
Disable photosynthesis model status messages.
printModelReport(self, Optional[List[int]] uuids=None)
Print model configuration report.
enableMessages(self)
Enable photosynthesis model status messages.
bool validateConfiguration(self)
Basic validation that model has been configured.
List[float] getC4ModelCoefficients(self, int uuid)
Return the 43-float C4 coefficient array for a single primitive.
setFarquharMesophyllConductance(self, float gm_at_25c, float dha=-1.0, float topt=-1.0, float dhd=-1.0, Optional[List[int]] uuids=None)
Set Farquhar mesophyll conductance gm (mol CO2 / m² / s / bar) for selected primitives.
setFarquharCoefficientsFromLibrary(self, str species, Optional[List[int]] uuids=None)
Set Farquhar model coefficients from built-in species library.
setJmax(self, float jmax, List[int] uuids, Optional[float] dha=None, Optional[float] topt=None, Optional[float] dhd=None)
Set maximum electron transport rate for Farquhar model.
cleanup(self)
Clean up native resources.
__enter__(self)
Context manager entry.
List[float] getFarquharModelCoefficients(self, int uuid)
Get Farquhar model coefficients for a specific primitive.
get_native_ptr(self)
Get the native C++ pointer for advanced operations.
setDarkRespiration(self, float respiration, List[int] uuids, Optional[float] dha=None, Optional[float] topt=None, Optional[float] dhd=None)
Set dark respiration rate.
setModelTypeFarquhar(self)
Set the photosynthesis model type to Farquhar-von Caemmerer-Berry.
List[float] getC4CoefficientsFromLibrary(self, str species)
Return the 43-float C4 coefficient array for species.
setVcmax(self, float vcmax, List[int] uuids, Optional[float] dha=None, Optional[float] topt=None, Optional[float] dhd=None)
Set maximum carboxylation rate for Farquhar model.
setModelTypeC4(self)
Set the photosynthesis model type to the von Caemmerer (2021) steady-state C4 model.
setModelTypeEmpirical(self)
Set the photosynthesis model type to empirical.
exportResults(self, str label)
Export photosynthesis results with optional label.
resetModel(self)
Reset the model by recreating it.
setQuantumEfficiency(self, float efficiency, List[int] uuids, Optional[float] dha=None, Optional[float] topt=None, Optional[float] dhd=None)
Set quantum efficiency of photosystem II.
setCm(self, float cm, List[int] uuids)
Manually prescribe the mesophyll cytosolic CO2 partial pressure (Cm) for the C4 model.
setEmpiricalModelCoefficients(self, EmpiricalModelCoefficients coefficients, Optional[List[int]] uuids=None)
Set empirical model coefficients.
dict get_species_aliases()
Static method to get species aliases mapping.
run(self)
Run photosynthesis calculations for all primitives in the context.
__init__(self, Context context)
Initialize PhotosynthesisModel.
runForPrimitives(self, Union[List[int], int] uuids)
Run photosynthesis calculations for specific primitives.
setFarquharModelCoefficients(self, FarquharModelCoefficients coefficients, Optional[List[int]] uuids=None)
Set Farquhar model coefficients.
List[str] get_available_species()
Static method to get available species without creating a model instance.
List[float] getEmpiricalModelCoefficients(self, int uuid)
Get empirical model coefficients for a specific primitive.
setC4ModelCoefficients(self, List[float] coefficients, Optional[List[int]] uuids=None, Optional[str] material_label=None)
Apply a 43-float C4 coefficient array.
List[float] getSpeciesCoefficients(self, str species)
Get Farquhar model coefficients for a species from the library.
setSpeciesCoefficients(self, str species, Optional[List[int]] uuids=None)
Set Farquhar model coefficients from built-in species library.
__exit__(self, exc_type, exc_value, traceback)
Context manager exit with cleanup.
__del__(self)
Destructor to ensure cleanup.
setLightResponseCurvature(self, float curvature, List[int] uuids, Optional[float] dha=None, Optional[float] topt=None, Optional[float] dhd=None)
Set light response curvature parameter.
Temperature response parameters for photosynthetic processes.