NEDAS package

Subpackages

• Assimilation tools
  • NEDAS.assim_tools.state
  • NEDAS.assim_tools.obs
  • NEDAS.assim_tools.assimilators
    • NEDAS.assim_tools.assimilators.base module
    • NEDAS.assim_tools.assimilators.batch module
      • BatchAssimilator
    • NEDAS.assim_tools.assimilators.ETKF module
      • ETKFAssimilator
    • NEDAS.assim_tools.assimilators.TopazDEnKF module
      • TopazDEnKFAssimilator
    • NEDAS.assim_tools.assimilators.serial module
      • SerialAssimilator
    • NEDAS.assim_tools.assimilators.EAKF module
      • EAKFAssimilator
  • NEDAS.assim_tools.inflation package
    • Submodules
    • NEDAS.assim_tools.inflation.RTPP module
      • RTPPInflation
    • NEDAS.assim_tools.inflation.base module
    • NEDAS.assim_tools.inflation.multiplicative module
      • MultiplicativeInflation
    • Module contents
      • get_inflation_func()
  • NEDAS.assim_tools.localization package
    • Submodules
    • NEDAS.assim_tools.localization.distance_based module
      • gaspari_cohn_func()
      • step_func()
      • exponential_func()
    • Module contents
      • get_localization_funcs()
  • NEDAS.assim_tools.misc_transform package
    • Submodules
    • NEDAS.assim_tools.misc_transform.identity module
    • NEDAS.assim_tools.misc_transform.scale_bandpass module
    • Module contents
  • NEDAS.assim_tools.updators package
    • Submodules
    • NEDAS.assim_tools.updators.additive module
      • AdditiveUpdator
    • NEDAS.assim_tools.updators.alignment module
      • AlignmentUpdator
      • optical_flow()
      • warp()
      • coarsen_mask()
      • coarsen()
      • sharpen()
      • interp2d()
      • deriv_y()
      • deriv_x()
      • laplacian()
    • NEDAS.assim_tools.updators.alignment_interp module
      • AlignmentUpdator
      • optical_flow()
      • warp()
      • coarsen_mask()
      • coarsen()
      • sharpen()
      • interp2d()
      • deriv_y()
      • deriv_x()
      • laplacian()
    • NEDAS.assim_tools.updators.base module
    • Module contents
      • get_updator()
• Configuration
  • NEDAS.config.config module
    • Config
      • Config.directories
      • Config.python_env
      • Config.io_mode
      • Config.job_submit
      • Config.nproc
      • Config.nproc_mem
      • Config.nproc_rec
      • Config.nproc_util
      • Config.pid
      • Config.pid_mem
      • Config.pid_rec
      • Config.pid_show
      • Config.nens
      • Config.run_preproc
      • Config.run_forecast
      • Config.run_analysis
      • Config.run_postproc
      • Config.run_diagnose
      • Config.step
      • Config.call_stack
      • Config.debug
      • Config.timer
      • Config.quiet
      • Config.interactive
      • Config.is_notebook
      • Config.call_stack_max_level
      • Config.cols
      • Config.anchor
      • Config.tabspace
      • Config.progress_bar_width
      • Config.time
      • Config.time_start
      • Config.time_end
      • Config.time_analysis_start
      • Config.time_analysis_end
      • Config.cycle_period
      • Config.forecast_period
      • Config.obs_time_steps
      • Config.obs_time_scale
      • Config.state_time_steps
      • Config.state_time_scale
      • Config.grid_def
      • Config.state_def
      • Config.model_def
      • Config.obs_def
      • Config.dataset_def
      • Config.shuffle_obs
      • Config.z_coords_from
      • Config.interp_method
      • Config.perturb
      • Config.scheme
      • Config.niter
      • Config.iter
      • Config.resolution_level
      • Config.character_length
      • Config.localize_scale_fac
      • Config.obs_err_scale_fac
      • Config.assimilator_def
      • Config.updator_def
      • Config.covariance_def
      • Config.inflation_def
      • Config.localization_def
      • Config.transform_def
      • Config.alignment
      • Config.diag
      • Config.work_dir
      • Config.dump_yaml()
      • Config.summary()
  • NEDAS.config.parse_config module
    • convert_notation()
    • str2bool()
    • parse_config()
• NEDAS.core package
  • Submodules
  • NEDAS.core.assimilator module
    • Assimilator
      • Assimilator.assimilate()
      • Assimilator.partition_grid()
      • Assimilator.init_partitions()
      • Assimilator.assign_obs()
      • Assimilator.distribute_partitions()
      • Assimilator.transpose_to_ensemble_complete()
      • Assimilator.transpose_to_field_complete()
      • Assimilator.assimilation_algorithm()
  • NEDAS.core.context module
    • Context
      • Context.comm
      • Context.comm_rec
      • Context.comm_mem
      • Context.progress
      • Context.grid
      • Context.grid_orig
      • Context.models
      • Context.datasets
      • Context.assimilator
      • Context.updator
      • Context.transform_funcs
      • Context.localization_funcs
      • Context.inflation_func
      • Context.state
      • Context.obs
      • Context.debug
      • Context.interactive
      • Context.is_notebook
      • Context.time
      • Context.iter
      • Context.pid_show
      • Context.nens
      • Context.mem_list
      • Context.fs
      • Context.io
      • Context.jsub
      • Context.check_interactive()
      • Context.check_notebook()
      • Context.get_cols()
      • Context.set_logging()
      • Context.distribute_mem_tasks()
      • Context.update_assim_tools()
      • Context.prev_time
      • Context.next_time
      • Context.set_comm()
      • Context.set_grid()
      • Context.set_models()
      • Context.set_datasets()
      • Context.total_tasks
      • Context.current_task
      • Context.message
      • Context.debug_message
      • Context.timer()
      • Context.logger()
      • Context.print_1p()
      • Context.log_event()
      • Context.show_greeting()
      • Context.show_summary()
      • Context.dump_config()
      • Context.run_job()
  • NEDAS.core.dataset module
    • Dataset
      • Dataset.variables
      • Dataset.obs_operator
      • Dataset.memory
      • Dataset.dataset_name
      • Dataset.c
      • Dataset.parse_kwargs()
      • Dataset.get_mstr()
      • Dataset.get_tstr()
      • Dataset.generate_obs_network()
      • Dataset.read_obs()
      • Dataset.read_obs_from_file()
      • Dataset.read_obs_from_memory()
      • Dataset.write_obs()
      • Dataset.write_obs_to_file()
      • Dataset.write_obs_to_memory()
      • Dataset.save_memory()
      • Dataset.load_memory()
  • NEDAS.core.inflation module
    • Inflation
      • Inflation.validate_obs_ens()
      • Inflation.obs_space_stats()
      • Inflation.adaptive_prior_inflation()
      • Inflation.adaptive_post_inflation()
      • Inflation.apply_inflation()
  • NEDAS.core.io_backend module
    • IOBackend
      • IOBackend.io_mode
      • IOBackend.tags
      • IOBackend.io_mode
      • IOBackend.tags
      • IOBackend.validate_tag()
      • IOBackend.prepare_fields_storage()
      • IOBackend.read_field()
      • IOBackend.write_field()
      • IOBackend.call_method()
      • IOBackend.save_ndarray()
      • IOBackend.load_ndarray()
      • IOBackend.save_debug_data()
  • NEDAS.core.model module
    • Model
      • Model.variables
      • Model.grid
      • Model.z
      • Model.mask
      • Model.ens_init_dir
      • Model.truth_dir
      • Model.ens_run_strategy
      • Model.nproc_per_run
      • Model.nproc_per_util
      • Model.walltime
      • Model.run_process
      • Model.run_status
      • Model.restart_dir
      • Model.forecast_period
      • Model.memory
      • Model.io_mode
      • Model.model_name
      • Model.c
      • Model.parse_kwargs()
      • Model.get_mstr()
      • Model.get_tstr()
      • Model.read_grid()
      • Model.read_var()
      • Model.read_var_from_file()
      • Model.read_var_from_memory()
      • Model.write_var()
      • Model.write_var_to_file()
      • Model.write_var_to_memory()
      • Model.save_memory()
      • Model.load_memory()
      • Model.z_coords()
      • Model.preprocess()
      • Model.postprocess()
      • Model.run()
      • Model.generate_truth()
      • Model.generate_init_ensemble()
  • NEDAS.core.obs module
    • Obs
      • Obs.obs_inds
      • Obs.obs_seq
      • Obs.obs_prior
      • Obs.lobs
      • Obs.lobs_prior
      • Obs.lobs_post
      • Obs.obs_post
      • Obs.data
      • Obs.obs_rec_list
      • Obs.distribute_obs_tasks()
      • Obs.get_ref_z()
      • Obs.state_to_obs()
      • Obs.get_model_fld_z_on_grid()
      • Obs.horizontal_interp()
      • Obs.vertical_interp()
      • Obs.validate_seq_shape()
      • Obs.collect_obs_seq()
      • Obs.prepare_obs()
      • Obs.prepare_obs_from_state()
      • Obs.global_obs_list()
      • Obs.transpose_obs_seq()
      • Obs.transpose_to_ensemble_complete()
      • Obs.transpose_to_field_complete()
      • Obs.pack_local_obs_data()
      • Obs.unpack_local_obs_data()
  • NEDAS.core.obs_info module
    • ObsInfo
      • ObsInfo.records
      • ObsInfo.variables
      • ObsInfo.err_types
      • ObsInfo.records
      • ObsInfo.variables
      • ObsInfo.err_types
      • ObsInfo.add_obs_record()
      • ObsInfo.complete_err_cross_corr_matrix()
  • NEDAS.core.scheme module
    • Scheme
      • Scheme.steps_need_mpi
      • Scheme.scheduler
      • Scheme.config
      • Scheme.online_mode
      • Scheme.use_synthetic_obs
      • Scheme.c
      • Scheme.run_all()
      • Scheme.external_call()
      • Scheme.run_step()
      • Scheme.run_ensemble_tasks()
  • NEDAS.core.state module
    • State
      • State.partitions
      • State.par_list
      • State.fields_prior
      • State.fields_z
      • State.state_prior
      • State.state_z
      • State.state_post
      • State.fields_post
      • State.data
      • State.info
      • State.rec_list
      • State.distribute_state_tasks()
      • State.prepare_state()
      • State.collect_prior_fields()
      • State.collect_scalar_variables()
      • State.output_state()
      • State.output_ens_mean()
      • State.output_ref_z()
      • State.pack_field_chunk()
      • State.unpack_field_chunk()
      • State.transpose_to_ensemble_complete()
      • State.transpose_to_field_complete()
      • State.pack_local_state_data()
      • State.unpack_local_state_data()
  • NEDAS.core.state_info module
    • StateInfo
      • StateInfo.shape
      • StateInfo.fields
      • StateInfo.size
      • StateInfo.variables
      • StateInfo.err_types
      • StateInfo.shape
      • StateInfo.mask
      • StateInfo.fields
      • StateInfo.size
      • StateInfo.variables
      • StateInfo.err_types
      • StateInfo.add_fields_for_variable()
      • StateInfo.write_to_file()
      • StateInfo.read_from_file()
  • NEDAS.core.transform module
    • Transform
      • Transform.forward_state()
      • Transform.backward_state()
      • Transform.forward_obs()
      • Transform.backward_obs()
  • NEDAS.core.types module
    • VarDesc
      • VarDesc.name
      • VarDesc.is_vector
      • VarDesc.dtype
      • VarDesc.dt
      • VarDesc.levels
      • VarDesc.units
      • VarDesc.z_units
      • VarDesc.asdict()
    • FieldRecord
      • FieldRecord.name
      • FieldRecord.model_src
      • FieldRecord.dtype
      • FieldRecord.is_vector
      • FieldRecord.units
      • FieldRecord.err_type
      • FieldRecord.time
      • FieldRecord.dt
      • FieldRecord.k
      • FieldRecord.pos
      • FieldRecord.name
      • FieldRecord.model_src
      • FieldRecord.dtype
      • FieldRecord.is_vector
      • FieldRecord.units
      • FieldRecord.err_type
      • FieldRecord.time
      • FieldRecord.dt
      • FieldRecord.k
      • FieldRecord.pos
      • FieldRecord.asdict()
    • ErrorModel
      • ErrorModel.type
      • ErrorModel.std
      • ErrorModel.hcorr
      • ErrorModel.vcorr
      • ErrorModel.tcorr
      • ErrorModel.cross_corr
      • ErrorModel.type
      • ErrorModel.std
      • ErrorModel.hcorr
      • ErrorModel.vcorr
      • ErrorModel.tcorr
      • ErrorModel.cross_corr
      • ErrorModel.asdict()
    • ObsRecord
      • ObsRecord.name
      • ObsRecord.dataset_src
      • ObsRecord.model_src
      • ObsRecord.nobs
      • ObsRecord.obs_window_min
      • ObsRecord.obs_window_max
      • ObsRecord.err
      • ObsRecord.dtype
      • ObsRecord.is_vector
      • ObsRecord.units
      • ObsRecord.z_units
      • ObsRecord.time
      • ObsRecord.dt
      • ObsRecord.name
      • ObsRecord.dataset_src
      • ObsRecord.model_src
      • ObsRecord.nobs
      • ObsRecord.obs_window_min
      • ObsRecord.obs_window_max
      • ObsRecord.dtype
      • ObsRecord.is_vector
      • ObsRecord.units
      • ObsRecord.z_units
      • ObsRecord.time
      • ObsRecord.dt
      • ObsRecord.err
      • ObsRecord.hroi
      • ObsRecord.vroi
      • ObsRecord.troi
      • ObsRecord.impact_on_state
      • ObsRecord.asdict()
  • NEDAS.core.updator module
    • Updator
      • Updator.increment
      • Updator.update()
      • Updator.init_all_file_locks()
      • Updator.compute_increment()
      • Updator.update_files()
  • Module contents
    • Context
      • Context.comm
      • Context.comm_rec
      • Context.comm_mem
      • Context.progress
      • Context.grid
      • Context.grid_orig
      • Context.models
      • Context.datasets
      • Context.assimilator
      • Context.updator
      • Context.transform_funcs
      • Context.localization_funcs
      • Context.inflation_func
      • Context.state
      • Context.obs
      • Context.debug
      • Context.interactive
      • Context.is_notebook
      • Context.time
      • Context.iter
      • Context.pid_show
      • Context.nens
      • Context.mem_list
      • Context.fs
      • Context.io
      • Context.jsub
      • Context.check_interactive()
      • Context.check_notebook()
      • Context.get_cols()
      • Context.set_logging()
      • Context.distribute_mem_tasks()
      • Context.update_assim_tools()
      • Context.prev_time
      • Context.next_time
      • Context.set_comm()
      • Context.set_grid()
      • Context.set_models()
      • Context.set_datasets()
      • Context.total_tasks
      • Context.current_task
      • Context.message
      • Context.debug_message
      • Context.timer()
      • Context.logger()
      • Context.print_1p()
      • Context.log_event()
      • Context.show_greeting()
      • Context.show_summary()
      • Context.dump_config()
      • Context.run_job()
    • Assimilator
      • Assimilator.assimilate()
      • Assimilator.partition_grid()
      • Assimilator.init_partitions()
      • Assimilator.assign_obs()
      • Assimilator.distribute_partitions()
      • Assimilator.transpose_to_ensemble_complete()
      • Assimilator.transpose_to_field_complete()
      • Assimilator.assimilation_algorithm()
    • Updator
      • Updator.increment
      • Updator.update()
      • Updator.init_all_file_locks()
      • Updator.compute_increment()
      • Updator.update_files()
    • Inflation
      • Inflation.validate_obs_ens()
      • Inflation.obs_space_stats()
      • Inflation.adaptive_prior_inflation()
      • Inflation.adaptive_post_inflation()
      • Inflation.apply_inflation()
    • Transform
      • Transform.forward_state()
      • Transform.backward_state()
      • Transform.forward_obs()
      • Transform.backward_obs()
    • Model
      • Model.variables
      • Model.grid
      • Model.z
      • Model.mask
      • Model.ens_init_dir
      • Model.truth_dir
      • Model.ens_run_strategy
      • Model.nproc_per_run
      • Model.nproc_per_util
      • Model.walltime
      • Model.run_process
      • Model.run_status
      • Model.restart_dir
      • Model.forecast_period
      • Model.memory
      • Model.io_mode
      • Model.model_name
      • Model.c
      • Model.parse_kwargs()
      • Model.get_mstr()
      • Model.get_tstr()
      • Model.read_grid()
      • Model.read_var()
      • Model.read_var_from_file()
      • Model.read_var_from_memory()
      • Model.write_var()
      • Model.write_var_to_file()
      • Model.write_var_to_memory()
      • Model.save_memory()
      • Model.load_memory()
      • Model.z_coords()
      • Model.preprocess()
      • Model.postprocess()
      • Model.run()
      • Model.generate_truth()
      • Model.generate_init_ensemble()
    • Dataset
      • Dataset.variables
      • Dataset.obs_operator
      • Dataset.memory
      • Dataset.dataset_name
      • Dataset.c
      • Dataset.parse_kwargs()
      • Dataset.get_mstr()
      • Dataset.get_tstr()
      • Dataset.generate_obs_network()
      • Dataset.read_obs()
      • Dataset.read_obs_from_file()
      • Dataset.read_obs_from_memory()
      • Dataset.write_obs()
      • Dataset.write_obs_to_file()
      • Dataset.write_obs_to_memory()
      • Dataset.save_memory()
      • Dataset.load_memory()
    • FileSystem
      • FileSystem.config
      • FileSystem.cycle_dir()
      • FileSystem.forecast_dir()
      • FileSystem.analysis_dir()
      • FileSystem.make_dir()
      • FileSystem.copy_file()
      • FileSystem.move_file()
      • FileSystem.move_files_to_dir()
      • FileSystem.remove_files()
      • FileSystem.remove_dir()
      • FileSystem.link_file()
    • IOBackend
      • IOBackend.io_mode
      • IOBackend.tags
      • IOBackend.io_mode
      • IOBackend.tags
      • IOBackend.validate_tag()
      • IOBackend.prepare_fields_storage()
      • IOBackend.read_field()
      • IOBackend.write_field()
      • IOBackend.call_method()
      • IOBackend.save_ndarray()
      • IOBackend.load_ndarray()
      • IOBackend.save_debug_data()
    • JobSubmitter
      • JobSubmitter.nproc
      • JobSubmitter.offset
      • JobSubmitter.nproc_avail
      • JobSubmitter.execute_command
      • JobSubmitter.parse_commands()
      • JobSubmitter.run()
    • State
      • State.partitions
      • State.par_list
      • State.fields_prior
      • State.fields_z
      • State.state_prior
      • State.state_z
      • State.state_post
      • State.fields_post
      • State.data
      • State.info
      • State.rec_list
      • State.distribute_state_tasks()
      • State.prepare_state()
      • State.collect_prior_fields()
      • State.collect_scalar_variables()
      • State.output_state()
      • State.output_ens_mean()
      • State.output_ref_z()
      • State.pack_field_chunk()
      • State.unpack_field_chunk()
      • State.transpose_to_ensemble_complete()
      • State.transpose_to_field_complete()
      • State.pack_local_state_data()
      • State.unpack_local_state_data()
    • Obs
      • Obs.obs_inds
      • Obs.obs_seq
      • Obs.obs_prior
      • Obs.lobs
      • Obs.lobs_prior
      • Obs.lobs_post
      • Obs.obs_post
      • Obs.data
      • Obs.obs_rec_list
      • Obs.distribute_obs_tasks()
      • Obs.get_ref_z()
      • Obs.state_to_obs()
      • Obs.get_model_fld_z_on_grid()
      • Obs.horizontal_interp()
      • Obs.vertical_interp()
      • Obs.validate_seq_shape()
      • Obs.collect_obs_seq()
      • Obs.prepare_obs()
      • Obs.prepare_obs_from_state()
      • Obs.global_obs_list()
      • Obs.transpose_obs_seq()
      • Obs.transpose_to_ensemble_complete()
      • Obs.transpose_to_field_complete()
      • Obs.pack_local_obs_data()
      • Obs.unpack_local_obs_data()
    • Perturbation
      • Perturbation.nfld
      • Perturbation.perturb
      • Perturbation.task_list
      • Perturbation.distribute_perturb_tasks()
      • Perturbation.count_num_fields()
      • Perturbation.prepare_perturb_dir()
      • Perturbation.save_perturb_data()
      • Perturbation.load_perturb_data()
      • Perturbation.collect_fields()
      • Perturbation.output_perturbed_fields()
    • Diagnostics
      • Diagnostics.task_list
      • Diagnostics.distribute_diag_tasks()
      • Diagnostics.init_file_locks()
    • Scheme
      • Scheme.steps_need_mpi
      • Scheme.scheduler
      • Scheme.config
      • Scheme.online_mode
      • Scheme.use_synthetic_obs
      • Scheme.c
      • Scheme.run_all()
      • Scheme.external_call()
      • Scheme.run_step()
      • Scheme.run_ensemble_tasks()
• NEDAS.datasets package
  • Subpackages
    • NEDAS.datasets.amsr2 package
      • Submodules
      • NEDAS.datasets.amsr2.amsr2_obs module
      • NEDAS.datasets.amsr2.rtm_amsr_fcts module
      • Module contents
    • NEDAS.datasets.cs2smos package
      • Submodules
      • NEDAS.datasets.cs2smos.cs2smos_obs module
      • Module contents
    • NEDAS.datasets.rgps package
      • Submodules
      • NEDAS.datasets.rgps.rgps_obs module
      • NEDAS.datasets.rgps.utils module
      • Module contents
    • NEDAS.datasets.synthetic package
      • Submodules
      • NEDAS.datasets.synthetic.synthetic_obs module
      • Module contents
    • NEDAS.datasets.topaz package
      • Submodules
      • NEDAS.datasets.topaz.topaz_prep_obs module
      • NEDAS.datasets.topaz.uf_data module
      • Module contents
    • NEDAS.datasets.vort2d package
      • Submodules
      • NEDAS.datasets.vort2d.vort2d_obs module
      • Module contents
  • Module contents
    • get_dataset_class()
• Diagnostic tools
  • Module contents
• Grid tools
  • NEDAS.grid.grid module
    • Classes
    • Map projections
    • Coordinates
    • Grid
      • Grid.regular_grid()
      • Grid.random_grid()
  • NEDAS.grid.grid_base module
  • NEDAS.grid.grid_regular module
    • RegularGrid
      • RegularGrid.pole_dim
      • RegularGrid.pole_index
      • RegularGrid.nx
      • RegularGrid.ny
      • RegularGrid.change_resolution_level()
      • RegularGrid.find_index()
      • RegularGrid.rotate_vectors()
      • RegularGrid.get_corners()
      • RegularGrid.interp()
      • RegularGrid.coarsen()
      • RegularGrid.plot_field()
  • NEDAS.grid.grid_irregular module
    • IrregularGrid
      • IrregularGrid.change_resolution_level()
      • IrregularGrid.find_index()
      • IrregularGrid.interp()
      • IrregularGrid.coarsen()
      • IrregularGrid.plot_field()
  • NEDAS.grid.grid_1d module
    • Grid1D
      • Grid1D.mask
      • Grid1D.x
      • Grid1D.regular
      • Grid1D.cyclic
      • Grid1D.nx
      • Grid1D.dx
      • Grid1D.Lx
      • Grid1D.regular_grid()
      • Grid1D.random_grid()
      • Grid1D.change_resolution_level()
      • Grid1D.dst_grid
      • Grid1D.set_destination_grid()
      • Grid1D.wrap_cyclic()
      • Grid1D.find_index()
      • Grid1D.interp()
      • Grid1D.coarsen()
      • Grid1D.convert()
      • Grid1D.distance()
      • Grid1D.plot_field()
      • Grid1D.plot_vectors()
• NEDAS.io_backends package
  • Submodules
  • NEDAS.io_backends.file_io module
  • NEDAS.io_backends.memory_io module
  • Module contents
    • get_io_backend()
• Job submitters
  • NEDAS.job_submitters.get_job_submitter module
  • NEDAS.job_submitters.base module
  • NEDAS.job_submitters.oar module
    • OARJobSubmitter
      • OARJobSubmitter.nproc_avail
      • OARJobSubmitter.node_list_avail
      • OARJobSubmitter.nnode_avail
      • OARJobSubmitter.ppn_avail
      • OARJobSubmitter.update_node_file()
      • OARJobSubmitter.execute_command
      • OARJobSubmitter.job_array_index_name
      • OARJobSubmitter.in_job_allocation
      • OARJobSubmitter.run_job_as_step()
      • OARJobSubmitter.submit_job_and_monitor()
      • OARJobSubmitter.job_submit_cmd()
      • OARJobSubmitter.get_job_id()
      • OARJobSubmitter.check_job_status()
  • NEDAS.job_submitters.slurm module
    • SLURMJobSubmitter
      • SLURMJobSubmitter.MAX_NTASKS
      • SLURMJobSubmitter.MAX_NNODES
      • SLURMJobSubmitter.MAX_PPN
      • SLURMJobSubmitter.nproc_avail
      • SLURMJobSubmitter.nnode_avail
      • SLURMJobSubmitter.ppn_avail
      • SLURMJobSubmitter.execute_command
      • SLURMJobSubmitter.job_array_index_name
      • SLURMJobSubmitter.in_job_allocation
      • SLURMJobSubmitter.submit_job_and_monitor()
• Models interface
  • NEDAS.models.base module
  • Supported models
    • NEDAS.models.lorenz96 package
      • Submodules
      • NEDAS.models.lorenz96.core module
      • NEDAS.models.lorenz96.generate_init_ensemble module
      • NEDAS.models.lorenz96.generate_truth module
      • NEDAS.models.lorenz96.model module
      • Module contents
    • NEDAS.models.noresm package
      • Submodules
      • NEDAS.models.noresm.proj module
      • Module contents
    • NEDAS.models.qg package
      • Subpackages
      • Submodules
      • NEDAS.models.qg.bin2nc module
      • NEDAS.models.qg.generate_init_ensemble module
      • NEDAS.models.qg.generate_truth module
      • NEDAS.models.qg.model module
      • NEDAS.models.qg.namelist module
      • NEDAS.models.qg.run module
      • NEDAS.models.qg.util module
      • Module contents
    • NEDAS.models.vort2d package
      • Submodules
      • NEDAS.models.vort2d.generate_init_ensemble module
      • NEDAS.models.vort2d.generate_truth module
      • NEDAS.models.vort2d.model module
      • NEDAS.models.vort2d.util module
      • Module contents
    • NEDAS.models.wrf package
      • Submodules
      • NEDAS.models.wrf.model module
      • NEDAS.models.wrf.namelist module
      • NEDAS.models.wrf.restart_io module
      • Module contents
• Other utility modules
  • NEDAS.utils.conversion module
    • units_convert()
    • proj2dict()
    • t2h()
    • h2t()
    • t2s()
    • s2t()
    • seconds_to_timestr()
    • ensure_list()
  • NEDAS.utils.shell_utils module
  • NEDAS.utils.netcdf_lib module
    • nc_open()
    • nc_close()
    • nc_write_var()
    • nc_read_var()
  • NEDAS.utils.fft_lib module
    • fft2()
    • ifft2()
    • fftwn()
    • get_wn()
  • NEDAS.utils.njit module
  • NEDAS.utils.parallel module
    • Comm
      • Comm.parallel_io
      • Comm.mpi_ready
      • Comm.parallel_io
      • Comm.init_file_lock()
      • Comm.check_parallel_io()
      • Comm.cleanup_file_locks()
      • Comm.acquire_file_lock()
      • Comm.release_file_lock()
      • Comm.finalize()
    • DummyComm
      • DummyComm.Get_size()
      • DummyComm.Get_rank()
      • DummyComm.Barrier()
      • DummyComm.Abort()
      • DummyComm.Split()
      • DummyComm.bcast()
      • DummyComm.send()
      • DummyComm.recv()
      • DummyComm.allgather()
      • DummyComm.gather()
      • DummyComm.allreduce()
      • DummyComm.reduce()
    • by_rank()
    • bcast_by_root()
    • distribute_tasks()
    • OfflineScheduler
      • OfflineScheduler.submit_job()
      • OfflineScheduler.monitor_job_queue()
      • OfflineScheduler.start_queue()
      • OfflineScheduler.shutdown()
  • NEDAS.utils.progress module
    • print_with_cache()
    • watch_files()
    • watch_log()
    • find_keyword_in_file()
    • count_lines_in_file()
    • Formatter
      • Formatter.strip_escape_code()
      • Formatter.truncate()
      • Formatter.indent()
      • Formatter.padding()
      • Formatter.dimmer()
      • Formatter.progress_bar()
    • Progress
      • Progress.formatter
      • Progress.interactive
      • Progress.debug
      • Progress.call_stack
      • Progress.call_stack_max_level
      • Progress.new_node()
      • Progress.node
      • Progress.within_max_level()
      • Progress.is_leaf()
      • Progress.level
      • Progress.set_flag()
      • Progress.get_timer_msg()
      • Progress.push()
      • Progress.pop()
      • Progress.update()
      • Progress.log()
  • NEDAS.utils.random_perturb module
    • random_field_gaussian()
    • gaussian()
    • get_sig_in_gaussian()
    • random_field_powerlaw()
    • random_displacement()
    • get_velocity_from_press()
  • NEDAS.utils.spatial_operation module
    • gradx()
    • grady()
    • gradx2()
    • grady2()
    • gradxy()
    • laplacian()
    • coarsen()
    • refine()
    • coarsen_mask()
    • coarsen_field()
    • sharpen_field()
    • warp()
  • NEDAS.utils.multiscale module
    • lowpass_response()
    • get_scale_component_spec_bandpass()
    • convolve()
    • get_scale_component_convolve()
    • get_scale_component()
    • get_error_scale_factor()
  • NEDAS.utils.graphics module
    • get_cmap()
    • adjust_ax_size()
    • add_colorbar()
    • arrowhead_xy()
    • draw_reference_vector_legend()
    • draw_line()
    • draw_patch()

Module contents

NEDAS.get_scheme(config: Config | None = None, config_file: str | None = None, parse_args: bool = False, **kwargs) → Scheme

Factory function to get the correct analysis scheme instance.

Parameters:

• config (Config, optional) – configuration object.

• config_file (str, optional) – the top-level configuration file

• parse_args (bool, optional) – whether to parse runtime argument from cli, default to false.

• **kwargs – other key value pairs to rewrite the configuration

Returns:

The analysis scheme class instance.

Return type:

Scheme