NEDAS.models package

NEDAS.models.get_model_class(model_name: str) → Type['Model']

Factory function to return the correct Model subclass.

Parameters:

model_name (str) – Model name

Returns:

Corresponding Model subclass

Return type:

Type[“Model”]

Subpackages

• NEDAS.models.lorenz96 package
  • Lorenz96Model
    • Lorenz96Model.io_mode
    • Lorenz96Model.nx
    • Lorenz96Model.F
    • Lorenz96Model.dt
    • Lorenz96Model.restart_dt
    • Lorenz96Model.numeric_opt
    • Lorenz96Model.memory
    • Lorenz96Model.dxdt()
    • Lorenz96Model.run_1step_euler_forward()
    • Lorenz96Model.run_1step_rk4()
    • Lorenz96Model.advance_time()
    • Lorenz96Model.filename()
    • Lorenz96Model.read_grid()
    • Lorenz96Model.read_mask()
    • Lorenz96Model.read_var_from_file()
    • Lorenz96Model.write_var_to_file()
    • Lorenz96Model.z_coords()
    • Lorenz96Model.generate_initial_condition()
    • Lorenz96Model.preprocess()
    • Lorenz96Model.postprocess()
    • Lorenz96Model.run()
    • Lorenz96Model.generate_truth()
    • Lorenz96Model.generate_init_ensemble()
  • Submodules
    • NEDAS.models.lorenz96.lorenz96_model module
      • Lorenz96Model
• NEDAS.models.nextsim namespace
  • Subpackages
    • NEDAS.models.nextsim.dg package
      • NextsimDGModel
      • Submodules
    • NEDAS.models.nextsim.v1 package
      • NextsimModel
      • Submodules
• NEDAS.models.noresm package
  • NorESM
  • filename()
  • grid_info()
  • read_grid()
  • write_grid()
  • read_var()
  • write_var()
  • Submodules
    • NEDAS.models.noresm.proj module
      • lonlat2sxy()
      • sxy2lonlat()
      • spherdist()
      • tri_area()
      • pivotp()
      • find_grid_index()
      • lonlat2xy()
      • xy2lonlat()
• NEDAS.models.qg namespace
  • Subpackages
    • NEDAS.models.qg.fortran package
      • QGFortranModel
      • Subpackages
      • Submodules
    • NEDAS.models.qg.python package
      • Submodules
• NEDAS.models.topaz namespace
  • Subpackages
    • NEDAS.models.topaz.v4 package
      • Topaz4Model
      • Submodules
    • NEDAS.models.topaz.v5 package
      • Topaz5Model
      • Submodules
  • Submodules
    • NEDAS.models.topaz.abfile module
      • AFileError
      • BFileError
      • AFile
      • ABFile
      • ABFileBathy
      • ABFileRmu
      • ABFileGrid
      • ABFileArchv
      • ABFileForcing
      • ABFileRiver
      • ABFileRestart
      • ABFileRelax
      • ABFileRelaxZ
      • write_bathymetry()
      • write_regional_grid()
      • read_regional_grid()
      • write_diag_nc()
    • NEDAS.models.topaz.confmap module
      • ConformalMapping
    • NEDAS.models.topaz.model_grid module
      • get_topaz_grid()
      • get_depth()
      • get_mean_ssh()
      • stagger()
      • destagger()
    • NEDAS.models.topaz.time_format module
      • diy()
      • forday()
      • dayfor()
      • datetojul()
      • jultodate()
• NEDAS.models.vort2d package
  • Vort2DModel
    • Vort2DModel.nx
    • Vort2DModel.ny
    • Vort2DModel.dx
    • Vort2DModel.dt
    • Vort2DModel.restart_dt
    • Vort2DModel.Vmax
    • Vort2DModel.Rmw
    • Vort2DModel.Vbg
    • Vort2DModel.Vslope
    • Vort2DModel.loc_sprd
    • Vort2DModel.gen
    • Vort2DModel.diss
    • Vort2DModel.memory
    • Vort2DModel.filename()
    • Vort2DModel.read_grid()
    • Vort2DModel.read_mask()
    • Vort2DModel.read_var_from_file()
    • Vort2DModel.write_var_to_file()
    • Vort2DModel.z_coords()
    • Vort2DModel.generate_initial_condition()
    • Vort2DModel.preprocess()
    • Vort2DModel.postprocess()
    • Vort2DModel.run()
    • Vort2DModel.generate_truth()
    • Vort2DModel.generate_init_ensemble()
  • Submodules
    • NEDAS.models.vort2d.util module
      • initial_condition()
      • rankine_vortex()
      • random_flow()
      • advance_time()
      • get_scaled_wn()
      • forcing()
    • NEDAS.models.vort2d.vort2d_model module
      • Vort2DModel
• NEDAS.models.wrf package
  • WRFModel
    • WRFModel.map_proj
    • WRFModel.ref_lat
    • WRFModel.ref_lon
    • WRFModel.truelat1
    • WRFModel.truelat2
    • WRFModel.max_dom
    • WRFModel.e_we
    • WRFModel.e_sn
    • WRFModel.e_vert
    • WRFModel.dx
    • WRFModel.dy
    • WRFModel.model_code_dir
    • WRFModel.z_units
    • WRFModel.restart_dt
    • WRFModel.filename()
    • WRFModel.read_grid()
    • WRFModel.read_var()
    • WRFModel.write_var()
    • WRFModel.z_coords()
    • WRFModel.preprocess()
    • WRFModel.postprocess()
    • WRFModel.run()
  • Submodules
    • NEDAS.models.wrf.namelist module
      • bool_str()
      • namelist()
    • NEDAS.models.wrf.restart_io module
      • read_chunks()
      • write_chunks()
      • transpose_chunks_to_fields()
      • transpose_fields_to_chunks()
      • read_fields_bin()
      • write_fields_bin()
      • read_fields_nc()
      • write_fields_nc()
    • NEDAS.models.wrf.wrf_model module
      • WRFModel