easy_vic_build.Evb_dir_class

Evb_dir_class - A Python module for managing directory structures in the EVB.

This module provides a class for managing directory structures related to different case scenarios in the VIC model. The Evb_dir class simplifies the creation, organization, and retrieval of directories required for storing input, output, and parameter files used in VIC simulations. It ensures that necessary directories are properly structured and accessible.

Class:

  • Evb_dir: A class to handle the creation and management of directory structures for different case

    scenarios in the VIC model. The Evb_dir class defines methods and properties for managing directories and paths related to the VIC model’s operations. It helps automate the creation of necessary directories for model configuration, calibration, and execution.

Usage:

  1. Instantiate Evb_dir and pass parameters into it.

  2. Call Evb_dir.builddir to build file tree structure.

  3. Get and use the attributes of the Evb_dir.

Example

To use the Evb_dir
>>> from Evb_dir_class import Evb_dir
>>> project = Evb_dir(case_name="baseline_scenario")
>>> project.builddir()  # Creates ./baseline_scenario/...
>>> print(project.dpcFile_dir)  # Outputs "/abs/path/baseline_scenario/dpcFile"

Dependencies:

  • os: Provides functions for interacting with the operating system, such as creating directories.

  • shutil: Used for high-level file and directory operations, including copying and moving files.

Classes

Evb_dir([cases_home])

A class to handle the creation and management of directory structures for different case scenarios in the VIC model deployment process.
class easy_vic_build.Evb_dir_class.Evb_dir(cases_home=None)[source]

Bases: object

A class to handle the creation and management of directory structures for different case scenarios in the VIC model deployment process.

property MeteForcing_src_dir
property MeteForcing_src_suffix
__init__(cases_home=None)[source]

Initialize the directory paths for a given case name or set the default to current working directory.

builddir(case_name)[source]

Create directories and set paths for a specific case name.

property calibrate_cp_path
property domainFile_path
property dpc_VIC_level0_path
property dpc_VIC_level1_path
property dpc_VIC_level2_path
property dpc_VIC_level3_path
property dpc_VIC_plot_columns_path
property dpc_VIC_plot_grid_basin_path
property flow_direction_file_path
property forcing_prefix
property globalParam_path
property globalParam_reference_path
property linux_share_temp_dir
property params_dataset_level0_path
property params_dataset_level1_path
property pourpoint_file_path
property rout_param_dir
property rvic_conv_cfg_file_path
property rvic_conv_cfg_file_reference_path
property rvic_param_cfg_file_path
property rvic_param_cfg_file_reference_path
property uhbox_file_path
property veg_param_json_path
property vic_exe_path