pySVA documentation
pySVA is a Python-based open-source toolbox for computing terms in a salinity variance budget on unstructured mesh model output, particularly from models like D-FLOW Flexible Mesh.
The toolbox implements the salinity variance budget framework of Burchard et al. (2008) and Li et al. (2018), which decomposes tracer variance changes into contributions from advection, straining/mixing, and dissipation. This approach enables quantification of both physical and numerical mixing processes in hydrodynamic models.
Citation:
Geraeds, M. (2025). pySVA: Python-based toolbox for salinity variance budget computations on unstructured model output. 4TU.ResearchData. Software. https://doi.org/10.4121/66de21de-b6b7-462d-8a50-dbcf4f858b64
BibTeX:
@misc{geraeds_pysva,
title = {pySVA: Python-based toolbox for salinity variance budget computations on unstructured model output},
author = {Geraeds, M.},
publisher = {4TU.ResearchData},
year = {2025},
version = {1.0},
doi = {10.4121/66de21de-b6b7-462d-8a50-dbcf4f858b64},
}
Contents
Contents:
- Overview
- Theory: Salinity Variance Budget
- Installation & Getting Started
- API Reference
constructorSVAbuild_edge_face_weights()build_edge_node_connectivity()build_face_edge_connectivity()build_inverse_distance_weights()calculate_distance_haversine()calculate_distance_pythagoras()calculate_distance_vectors()calculate_unit_normal_vectors()compute_divergence_on_face()compute_gradient_on_face()compute_kzz()deprecated()depth_int2volume_int()differentiate_over_3d_coord()get_all_coordinates()integrate_trapz()reconstruct_vector_form()reconstruct_vector_form_magnitude()uda_to_edges()
- Overview
- Theory: Salinity Variance Budget
- Installation & Getting Started
- API Reference
constructorSVAbuild_edge_face_weights()build_edge_node_connectivity()build_face_edge_connectivity()build_inverse_distance_weights()calculate_distance_haversine()calculate_distance_pythagoras()calculate_distance_vectors()calculate_unit_normal_vectors()compute_divergence_on_face()compute_gradient_on_face()compute_kzz()deprecated()depth_int2volume_int()differentiate_over_3d_coord()get_all_coordinates()integrate_trapz()reconstruct_vector_form()reconstruct_vector_form_magnitude()uda_to_edges()