DataAssimBench Documentation

DataAssimBench is a Python package for benchmarking Data Assimilation workflows.

Contents

• API Reference
  • dabench
    • Submodules
      • dabench.dacycler
        • Classes
        • Package Contents
          • DACycler
            • DACycler.cycle()
          • ETKF
          • Var3D
          • Var4D
          • Var4DBackprop
      • dabench.data
        • Classes
        • Package Contents
          • Barotropic
            • Barotropic.__advance__()
            • Barotropic.forecast()
            • Barotropic.generate()
          • Data
            • Data.calc_lyapunov_exponents_final()
            • Data.calc_lyapunov_exponents_series()
            • Data.generate()
            • Data.load_netcdf()
            • Data.rhs_aux()
            • Data.save_netcdf()
          • ENSOIndices
            • ENSOIndices.generate()
          • GCP
            • GCP.generate()
            • GCP.load()
          • Lorenz63
            • Lorenz63.Jacobian()
            • Lorenz63.rhs()
          • Lorenz96
            • Lorenz96.Jacobian()
            • Lorenz96.rhs()
          • PyQG
            • PyQG.__advance__()
            • PyQG.forecast()
            • PyQG.generate()
          • PyQGJax
            • PyQGJax.forecast()
            • PyQGJax.generate()
          • QGS
            • QGS.Jacobian()
            • QGS.calc_lyapunov_exponents_series()
            • QGS.generate()
            • QGS.rhs()
            • QGS.rhs_aux()
          • SQGTurb
            • SQGTurb.fft2()
            • SQGTurb.fft2_2dto1d()
            • SQGTurb.ifft2()
            • SQGTurb.ifft2_2dto1d()
            • SQGTurb.integrate()
            • SQGTurb.map1dto2d()
            • SQGTurb.map1dto2d_fft2()
            • SQGTurb.map1dto2d_ifft2()
            • SQGTurb.map2dto1d()
            • SQGTurb.rhs()
      • dabench.model
        • Classes
        • Package Contents
          • Model
          • RCModel
            • RCModel.generate()
            • RCModel.load_weights()
            • RCModel.predict()
            • RCModel.readout()
            • RCModel.save_weights()
            • RCModel.train()
            • RCModel.update()
            • RCModel.weights_init()
      • dabench.observer
        • Classes
        • Package Contents
          • Observer
            • Observer.locations
            • Observer.location_dim
            • Observer.times
            • Observer.time_dim
            • Observer.observe()

Note

This project is under active development.