Skip to content

configuration

BaseDatasetConfiguration

Bases: BaseModel

This is the class that should be imported into main.py files within dataset directories, and built upon with Dataset-specific parameters. Common examples are overwrite_download, overwrite_processing, or year_list.

Source code in data_manager/configuration.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
class BaseDatasetConfiguration(BaseModel):
    """
    This is the class that should be imported into
    `main.py` files within dataset directories, and
    built upon with Dataset-specific parameters.
    Common examples are `overwrite_download`,
    `overwrite_processing`, or `year_list`.
    """

    run: RunParameters
    """
    A `RunParameters` model that defines how this model should be run.
    This is passed into the `Dataset.run()` function.
    """

run instance-attribute

A RunParameters model that defines how this model should be run. This is passed into the Dataset.run() function.

RunParameters

Bases: BaseModel

This is a pydantic BaseModel that represents the run parameters for a Dataset. This model is consumed by Dataset.run() as settings for how to run the Dataset.

Source code in data_manager/configuration.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
class RunParameters(BaseModel):
    """
    This is a pydantic BaseModel that represents the run
    parameters for a Dataset. This model is consumed by
    Dataset.run() as settings for how to run the Dataset.
    """

    backend: Literal["local", "mpi", "prefect"] = "prefect"
    task_runner: Literal[
        "concurrent",
        "dask",
        "hpc",
        "kubernetes",
        "sequential",
    ] = "concurrent"
    """
    The backend to run the dataset on.
    Most common values are "sequential", and "concurrent"
    """
    run_parallel: bool = True
    """
    Whether or not to run the Dataset in parallel.
    """
    max_workers: Optional[int] = 4
    """
    Maximum number of concurrent tasks that may be run for this Dataset.
    This may be overridden when calling `Dataset.run_tasks()`
    """
    bypass_error_wrapper: bool = False
    """
    If set to `True`, exceptions will not be caught when running tasks, and will instead stop execution of the entire dataset.
    This can be helpful for quickly debugging a dataset, especially when it is running sequentially.
    """
    threads_per_worker: Optional[int] = 1
    """
    `threads_per_worker` passed through to the DaskCluster when using the dask task runner.
    """
    # cores_per_process: Optional[int] = None
    chunksize: int = 1
    """
    Sets the chunksize for pools created for concurrent or MPI task runners.
    """
    log_dir: str
    """
    Path to directory where logs for this Dataset run should be saved.
    This is the only run parameter without a default, so it must be set in a Dataset's configuration file.
    """
    logger_level: int = logging.INFO
    """
    Minimum log level to log.
    For more information, see the [relevant Python documentation](https://docs.python.org/3/library/logging.html#logging-levels).
    """
    retries: int = 3
    """
    Number of times to retry each task before giving up.
    This parameter can be overridden per task run when calling `Dataset.run_tasks()`
    """
    retry_delay: int = 5
    """
    Time in seconds to wait between task retries.
    This parameter can be overridden per task run when calling `Dataset.run_tasks()`
    """
    conda_env: str = "geodata38"
    """
    Conda environment to use when running the dataset.
    **Deprecated because we do not use this in the new Prefect/Kubernetes setup**
    """

bypass_error_wrapper = False class-attribute instance-attribute

If set to True, exceptions will not be caught when running tasks, and will instead stop execution of the entire dataset. This can be helpful for quickly debugging a dataset, especially when it is running sequentially.

chunksize = 1 class-attribute instance-attribute

Sets the chunksize for pools created for concurrent or MPI task runners.

conda_env = 'geodata38' class-attribute instance-attribute

Conda environment to use when running the dataset. Deprecated because we do not use this in the new Prefect/Kubernetes setup

log_dir instance-attribute

Path to directory where logs for this Dataset run should be saved. This is the only run parameter without a default, so it must be set in a Dataset's configuration file.

logger_level = logging.INFO class-attribute instance-attribute

Minimum log level to log. For more information, see the relevant Python documentation.

max_workers = 4 class-attribute instance-attribute

Maximum number of concurrent tasks that may be run for this Dataset. This may be overridden when calling Dataset.run_tasks()

retries = 3 class-attribute instance-attribute

Number of times to retry each task before giving up. This parameter can be overridden per task run when calling Dataset.run_tasks()

retry_delay = 5 class-attribute instance-attribute

Time in seconds to wait between task retries. This parameter can be overridden per task run when calling Dataset.run_tasks()

run_parallel = True class-attribute instance-attribute

Whether or not to run the Dataset in parallel.

task_runner = 'concurrent' class-attribute instance-attribute

The backend to run the dataset on. Most common values are "sequential", and "concurrent"

threads_per_worker = 1 class-attribute instance-attribute

threads_per_worker passed through to the DaskCluster when using the dask task runner.

get_config(model, config_path='config.toml')

Load the configuration for a Dataset.

This function reads a TOML configuration file (usually config.toml) out of the same directory as the main.py file, and returns a BaseDatasetConfiguration model filled in with the values from that configuration file.

Parameters:

Name Type Description Default
model BaseDatasetConfiguration

The model to load the configuration values into. This should nearly always be a Dataset-specific model defined in main.py that inherits `BaseDatasetConfiguration.

 required
config_path Union[Path, str]

The relative path to the TOML configuration file. It's unlikely this parameter should ever be changed from its default.

 'config.toml'
Source code in data_manager/configuration.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
def get_config(
    model: BaseDatasetConfiguration, config_path: Union[Path, str] = "config.toml"
):
    """
    Load the configuration for a Dataset.

    This function reads a TOML configuration
    file (usually `config.toml`) out of the
    same directory as the `main.py` file, and
    returns a `BaseDatasetConfiguration` model
    filled in with the values from that
    configuration file.

    Parameters:
        model: The model to load the configuration values into. This should nearly always be a Dataset-specific model defined in `main.py` that inherits `BaseDatasetConfiguration.
        config_path: The relative path to the TOML configuration file. It's unlikely this parameter should ever be changed from its default.
    """
    config_path = Path(config_path)
    if config_path.exists():
        with open(config_path, "rb") as src:
            return model.model_validate(tomllib.load(src))
    else:
        return FileNotFoundError("No TOML config file found for dataset.")