geoprior.scripts.config

Shared configuration helpers for GeoPrior scripts.

Functions

export_env_summary()	Return resolved export environment values.
fig_dir(*[, create])	Return the figure export directory.
out_dir(*[, create])	Return the tabular export directory.
resolve_export_path(kind, *parts[, ...])	Resolve a path under fig/ or out/.
resolve_user_artifact_path(value, *, kind[, ...])	Resolve a user-provided export path.
scripts_root(*[, create])	Return the user-facing artifact root.

geoprior.scripts.config.scripts_root(*, create=True)

Return the user-facing artifact root.

Parameters:

create (bool)

Return type:

Path

geoprior.scripts.config.fig_dir(*, create=True)

Return the figure export directory.

Parameters:

create (bool)

Return type:

Path

geoprior.scripts.config.out_dir(*, create=True)

Return the tabular export directory.

Parameters:

create (bool)

Return type:

Path

geoprior.scripts.config.resolve_user_artifact_path(value, *, kind, create_parent=False)

Resolve a user-provided export path.

Parameters:

• value (str | PathLike[str])

• kind (str)

• create_parent (bool)

Return type:

Path

geoprior.scripts.config.resolve_export_path(kind, *parts, create_parent=True)

Resolve a path under fig/ or out/.

Parameters:

• kind (str)

• parts (str | PathLike[str])

• create_parent (bool)

Return type:

Path

geoprior.scripts.config.export_env_summary()

Return resolved export environment values.

Return type:

dict[str, str]