FINAM - is not a model (v1.0): a new Python-based model coupling framework

We present a new coupling framework named FINAM (short for "FINAM Is Not A Model"). FINAM is designed to facilitate the coupling of models that were developed as stand-alone tools in the first place, and to enable seamless model extensions by wrapping existing models into components with well-specified interfaces. Although established coupling solutions such as YAC (Hanke et al., 2016), ESMF (Collins et al., 2005), or OASIS (Craig et al., 2017) focus on highly parallel workflows, complex data processing, and regridding, FINAM prioritizes usability and flexibility, allowing users to focus on scientific exploration of coupling scenarios rather than technical complexities. FINAM emphasizes ease of use for end users to create, run, and modify model couplings, as well as for model developers to create and maintain components for their models. The framework is particularly suited for applications where rapid prototyping and flexible model extensions are desired. It is primarily targeting environmental models, including ecological models for animal populations, individual-based forest models, field-scale crop models, economical models, as well as hydrologic and hydrogeological models. Python's robust interoperability features further enhance FINAM's capabilities, allowing to wrap and use models written in various programming languages like Fortran, C, C++, Rust, and others. We will describe the main principles and modules of FINAM and presents example workflows to demonstrate its features. These examples range from simple toy models to well-established models like OpenGeoSys and Bodium covering features like bidirectional dependencies, complex model coupling, and spatio-temporal regridding.

Links

• FINAM website: https://finam.pages.ufz.de
• FINAM paper preprint: https://doi.org/10.5194/gmd-2024-144

Refrences

• Hanke, M., Redler, R., Holfeld, T., and Yastremsky, M.: YAC 1.2.0: new aspects for coupling software in Earth system modelling, Geosci-
  entific Model Development, 9, 2755–2769, https://doi.org/10.5194/gmd-9-2755-2016, publisher: Copernicus GmbH, 2016.
• Collins, N., Theurich, G., DeLuca, C., Suarez, M., Trayanov, A., Balaji, V., Li, P., Yang, W., Hill, C., and da Silva, A.: Design and Implemen-
  tation of Components in the Earth System Modeling Framework, The International Journal of High Performance Computing Applications,
  19, 341–350, https://doi.org/10.1177/1094342005056120, publisher: SAGE Publications Ltd STM, 2005.
• Craig, A., Valcke, S., and Coquart, L.: Development and performance of a new version of the OASIS coupler, OASIS3-MCT_3.0, Geoscien-
  tific Model Development, 10, 3297–3308, https://doi.org/10.5194/gmd-10-3297-2017, publisher: Copernicus GmbH, 2017.