BuildArgs#

class caf.ntem.build.BuildArgs(*, output_path, directory, scenarios=None)[source]#

Bases: InputBase

Input arguments for the build command.

Attributes

logging_path

Path to log file for the module.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

output_path

Path to directory to output SQLite database file.

directory

Directory containing NTEM MS Access files

scenarios

Scenarios to port into the database

Methods

run()

Run the build functionality using the args defined.

Attributes Documentation

Parameters:
  • output_path (Path)

  • directory (Annotated[Path, PathType(path_type=dir)])

  • scenarios (list[Scenarios] | None)

logging_path#

Path to log file for the module.

model_config = {}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

output_path: pathlib.Path[source]#

Path to directory to output SQLite database file.

directory: pydantic.DirectoryPath[source]#

Directory containing NTEM MS Access files

scenarios: list[ntem_constants.Scenarios] | None[source]#

Scenarios to port into the database