eophis package

Subpackages

• eophis.coupling package
  • Submodules
  • eophis.coupling.namcouple module
    • close_tunnels()
    • init_namcouple()
    • open_tunnels()
    • register_tunnels()
    • tunnels_ready()
    • write_coupling_namelist()
  • eophis.coupling.namelist module
    • FortranNamelist
      • FortranNamelist.file_path
      • FortranNamelist.formatted
      • FortranNamelist.get()
      • FortranNamelist.write()
  • eophis.coupling.tunnel module
    • Tunnel
      • Tunnel.label
      • Tunnel.grids
      • Tunnel.exchs
      • Tunnel.geo_aliases
      • Tunnel.py_aliases
      • Tunnel._partitions
      • Tunnel._variables
      • Tunnel._static_used
      • Tunnel.arriving_list()
      • Tunnel.departure_list()
      • Tunnel.receive()
      • Tunnel.send()
  • Module contents
    • coupling subpackage
• eophis.domain package
  • Submodules
  • eophis.domain.cyclichalo module
  • eophis.domain.grid module
    • Domains
      • Domains.demo
      • Domains.eORCA05
      • Domains.eORCA025
      • Domains.eORCA025_U
      • Domains.eORCA025_V
      • Domains.eORCA025_F
      • Domains.demo
      • Domains.eORCA025
      • Domains.eORCA025_F
      • Domains.eORCA025_U
      • Domains.eORCA025_V
      • Domains.eORCA05
  • eophis.domain.halo module
  • eophis.domain.nfhalo module
  • eophis.domain.offsiz module
  • Module contents
    • domain subpackage
• eophis.utils package
  • Submodules
  • eophis.utils.logs module
    • abort()
    • info()
    • warning()
  • eophis.utils.params module
    • Freqs
      • Freqs.DAILY
      • Freqs.HOURLY
      • Freqs.MINUTLY
      • Freqs.MONTHLY
      • Freqs.STATIC
      • Freqs.WEEKLY
      • Freqs.YEARLY
    • set_mode()
  • eophis.utils.worker module
  • Module contents

Submodules

eophis.loop module

This module contains time loop structures to synchronize connexions between coupled scripts.

• Copyright (c) 2023 IGE-MEOM

  Eophis is released under an MIT License. See the LICENSE file for details.

eophis.loop.all_in_all_out(geo_model, step, niter)

Builds a Loop on All In All Out (AIAO) structure. assembler() function inserts router() inside base_loop() in which receivings and sendings steps are pre-defined.

Parameters:

• geo_model (eophis.Tunnel) – coupling Tunnel to perform exchanges with earth

• step (int) – loop time step, in seconds

• niter (int) – number of loop iteration

Returns:

base_loop – AIAO loop completed with router()

Return type:

function

Raises:

• eophis.abort() – if no router defined to construct loop

• eophis.abort() – if loop starts with tunnels not ready

Notes

An AIAO loop orchestrates the following steps:

1. receive all data from earth

2. transfert data to models (provided from router())

3. send back all results

Example

>>> @all_in_all_out(coupledEarth,timeStep,timeIter)
>>> def router(**inputs):
>>>     outputs = {}
>>>     outputs[varToSendBack] = my_model(inputs[varReceived])
>>>     return outputs

eophis.loop.starter(loop_router)

Starter for Loop-Router assembly.

Parameters:

assembled_loop (function) – Loop-Router to start

Module contents