GeoProspector Notes

Working notes for the GeoProspector project

Modules

Breakdown of modules, classes, and methods.

controls_config

Module for standard configuation options. Settings and controls used throughout the GeoProspector System are set here.

Process Controls

• PROSP_CONTROL_META_USERNAME: str
• PROSP_CONTROL_META_VERSION: str
• PROSP_CONTROL_META_MODEL: str
• PROSP_CONTROL_BOOLS_PANIC: bool
• PROSP_CONTROL_BOOLS_PRIME_ACCEPTABLE: bool
• PROSP_CONTROL_BOOLS_PRIME_POSSIBLE: bool
• PROSP_CONTROL_LOGS_LEVEL: str
• PROSP_CONTROL_LOGS_TAG: str
• PROSP_CONTROL_LOGS_ARCHIVE: bool
• PROSP_CONTROL_LOGS_OVERWRITE: bool
• PROSP_CONTROL_LOGS_DETAILED_TRACES: bool
• PROSP_CONTROL_LOGS_ASYNC: bool
• PROSP_CONTROL_LOGS_MEMRAY: bool
• PROSP_CONTROL_LOGS_CLEAR_TRACKER: bool
• PROSP_CONTROL_LOGS_RESET_COUNTER: bool
• PROSP_CONTROL_BOOLS_FORCE_CRS: bool

Process Directories and Filepaths

• PROSP_CWD: Path
• PROSP_DIR_ROOT: Path
• PROSP_DIR_TEMP: Path
• PROSP_DIR_LOGS: Path
• PROSP_DIR_DATA_ROOT: Path
• PROSP_DIR_DATA_RAW: Path
• PROSP_DIR_DATA_GIS: Path
• PROSP_DIR_DATA_PROCESSED: Path
• PROSP_DIR_DATA_INTERIM: Path
• PROSP_DIR_VARS: Path
• PROSP_DIR_CONTROLS: Path
• PROSP_DIR_SPATIAL_FILTERS: Path
• PROSP_DIR_REFERENCES: Path
• PROSP_DIR_REPORTING: Path
• PROSP_BC_NTS_MAPSHEETS: Path
• PROSP_BC_GRID_NAMES: Path
• PROSP_ALASKA_NTS_MAPSHEETS: Path
• PROSP_ALASKA_GRID_NAMES: Path
• PROSP_YUKON_NTS_MAPSHEETS: Path
• PROSP_YUKON_GRID_NAMES: Path
• PROSP_DIR_USERS: Path
• PROSP_CACHE_LATEST: Path
• PROSP_CACHE_LAST: Path
• PROSP_COLLECTIONS_LEVELS: list[str]
• PROSP_COLLECTIONS_DIRS: list[Path]
• PROSP_DIR_COLLECTIONS: dict[str, Path]
• PROSP_DIR_COLLECTION_LEVELS_LITERALS: Literal['base', 'nts', 'mapsheet', 'grid', 'block', 'quad', 'unit', 'subcell']
• PROSP_TRACKING_PROCESSED_DATASETS_PKL: Path
• PROSP_TRACKING_PROCESSED_DATASETS_CSV: Path
• PROSP_TRACKING_PROCESSED_COLLECTIONS_PKL: Path
• PROSP_TRACKING_PROCESSED_COLLECTIONS_CSV: Path
• PROSP_ACCEPTED_MAPSHEETS_PICKLE: Path
• PROSP_ACCEPTED_NTS_PICKLE: Path
• PROSP_ACCEPTED_GRIDS_PICKLE: Path
• PROSP_ACCEPTED_GEOM_FIELDS_PICKLE: Path
• PROSP_ACCEPTED_GEOM_PAIRS_PICKLE: Path
• PROSP_ACCEPTED_DTYPES: list[str]
• PROSP_POSSIBLE_MAPSHEET_NAMES_PICKLE: Path
• PROSP_POSSIBLE_GRID_NAMES_PICKLE: Path
• PROSP_POSSIBLE_BLOCK_NAMES_PICKLE: Path
• PROSP_POSSIBLE_QUAD_NAMES_PICKLE: Path
• PROSP_POSSIBLE_UNIT_NAMES_PICKLE: Path
• PROSP_POSSIBLE_CELL_NAMES_PICKLE: Path
• PROSP_POSSIBLE_SUBCELL_NAMES_PICKLE: Path

Time and Date Formatting

• PROSP_DT_TIMEZONE: str
• PROSP_DT_DATE_FORMAT: str
• PROSP_DT_DATETIME_FORMAT: str
• PROSP_DT_TODAY: str
• PROSP_DT_NOW: str
• PROSP_DT_YEAR: str

Background Settings

• PROSP_SETTINGS_TIMEOUT_CACHE: int
• PROSP_SETTINGS_MAX_RETRIES: int
• PROSP_SETTINGS_WAIT_RETRY: int
• PROSP_SETTINGS_DISPLAY_ZSCALE: int
• PROSP_SETTINGS_DEFAULT_FILLNA_NUM: int
• PROSP_SETTINGS_DEFAULT_FILLNA_STR: str
• PROSP_SETTINGS_PD_EXTENSIONS: list[str]
• PROSP_SETTINGS_PD_READ_ENGINES: list[str]
• PROSP_SETTINGS_ENGINE_PD_READ: str
• PROSP_SETTINGS_GPD_READ_ENGINES: list[str]
• PROSP_SETTINGS_ENGINE_GEOPANDAS_READ: str
• PROSP_SETTINGS_GIS_EXPORT_FILE: str
• PROSP_SETTINGS_GIS_FALLBACK_EXPORT_FILE: str
• PROSP_SETTINGS_GIS_EXPORT_DRIVER: str
• PROSP_SETTINGS_GPD_EXT_DRIVERS: dict[str, tuple[str, str]]

Logging

• PROSP_LOGGING_LEVEL: str
• PROSP_LOGGING_REPORTING_ROTATION: str
• PROSP_LOGGING_STANDARD_RETENTION: str
• PROSP_LOGGING_SHORT_RETENTION: str
• PROSP_LOGGING_ARCHIVE_COMPRESSION: str
• PROSP_LOGGING_SINK_PATH_ACTIVITY: Path
• PROSP_LOGGING_SINK_PATH_MAIN: Path
• PROSP_LOGGING_SINK_PATH_REPORT: Path
• PROSP_LOGGING_SINK_PATH_SERVER: Path
• PROSP_LOGGING_SINK_PATH_STDERR: Path
• PROSP_LOGGING_SINK_PATH_STDOUT: Path
• PROSP_LOGGING_SINK_PATH_VARS: Path
• PROSP_LOGGING_SINK_PATH_MEMRAY: Path
• PROSP_LOGGING_SINK_PATH_PANIC: Path
• PROSP_LOGGING_LEVEL_COLOURS: dict[str, tuple[int, str]]

Blockmodel Settings

• PROSP_BLOCKMODEL_BLOCK_KDIM: int
• PROSP_BLOCKMODEL_UPPER_ELEV: int
• PROSP_BLOCKMODEL_LOWER_ELEV: int
• PROSP_BLOCKMODEL_BASE_SLICE: str

Base Dataset Controls

• PROSP_BASE_CELL_INDEX_FIELD: str
• PROSP_BASE_SUBCELLS_PER_CELL: int
• PROSP_BASE_SUBCELLS_NAMES: list[str]
• PROSP_BASE_BC_NTS_GRID_NUMS: list[int]
• PROSP_BASE_BC_NTS_GRID_NAMES: list[str]
• PROSP_BASE_MAPSHEET_LETTERS: list[str]
• PROSP_BASE_GRID_NUMS: list[int]
• PROSP_BASE_GRID_NAMES: list[str]
• PROSP_BASE_BLOCK_LETTERS: list[str]
• PROSP_BASE_UNIT_NUMS: list[int]
• PROSP_BASE_UNIT_NAMES: list[str]
• PROSP_BASE_CELL_NAMES: list[str]
• PROSP_BASE_QUAD_NAMES: dict[str, list[str]]
• PROSP_BASE_ORG_CELL_SPLITS: dict[str, tuple[int, int]]
• PROSP_BASE_UPDATED_CELL_SPLITS: dict[str, tuple[int, int]]

Collection levels

• PROSP_COLLECTION_LEVEL_FIELDS: dict[str, list[str]]

Geometry Settings

• PROSP_GEOMETRY_FIELD: str
• PROSP_GEOMETRY_POINT_LATLON_FIELDS: tuple[str, str]
• PROSP_GEOMETRY_POINT_XY_FIELDS: tuple[str, str]
• PROSP_GEOMETRY_POINT_EASTING_NORTHING_FIELDS: tuple[str, str]
• PROSP_GEOMETRY_POINT_ME_MN_FIELDS: tuple[str, str]
• PROSP_GEOMETRY_POINT_EAST_NORTH_FIELDS: tuple[str, str]
• PROSP_GEOMETRY_AREA_DEFAULT_CONVERT: tuple[str, int]
• PROSP_GEOMETRY_AREA_FIELD: str
• PROSP_GEOMETRY_AREA_HECTORS_CONVERT: tuple[str, int]
• PROSP_GEOMETRY_AREA_HECTORS_FIELD: str
• PROSP_GEOMETRY_POINT_FLAVORS: dict[str, tuple[str, str]]

CRS Settings

• PROSP_CRS_PROJECT_DEFAULT: str
• PROSP_CRS_ALL_CRS_STRINGS: list[str]

Geochemistry Settings

• PROSP_GEOCHEM_MULTIPLIER_OVER: float
• PROSP_GEOCHEM_MULTIPLIER_UNDER: float
• PROSP_GEOCHEM_DEFAULT_ASSAY_UNIT: Literal["ppb", "ppm", "pct"]
• PROSP_GEOCHEM_DEFAULT_WEIGHT_UNIT: Literal["lbs", "kg", "oz", "grm"]

Geology Settings

• PROSP_GEOLOGY_CELL_MAJORITY_PCT: float

Geophysics Settings

• PROSP_GEOPHYSICS_GLOBAL_GRAV_MODELS: dict[str, dict[str, str | None]]

Keywords

• PROSP_KEYWORDS_DATASETS: dict[str, list[str]]
• PROSP_KEYWORDS_PROCESSING: dict[str, list[str]]
• PROSP_KEYWORDS_SCALE: dict[str, list[str]]
• PROSP_KEYWORDS_QUALITY_CODES: list[str]
• PROSP_KEYWORDS_SUCCESS: tuple[str, str]

controls_files

File management based on controls_config. Methods in here are for setting derived filepaths, caches, and log files (with rotations and retention settings).