compass.utilities.base.Directories#

class Directories(out, logs=None, clean_files=None, ordinance_files=None, jurisdiction_dbs=None)[source]#

Bases: object

Helper class to store directories used in COMPASS run

Parameters:

  • out (path-like) – Output directory for COMPASS run.

  • logs (path-like, optional) – Directory for storing logs. If not specified, defaults to out/logs. By default, None.

  • clean_files (path-like, optional) – Directory for storing cleaned ordinance files. If not specified, defaults to out/cleaned_text. By default, None.

  • ordinance_files (path-like, optional) – Directory for storing ordinance files. If not specified, defaults to out/ordinance_files. By default, None.

  • jurisdiction_dbs (path-like, optional) – Directory for storing jurisdiction databases. If not specified, defaults to out/jurisdiction_dbs. By default, None

Methods

make_dirs()

Create all directories if they do not exist
make_dirs()[source]#

Create all directories if they do not exist