Paths

Paths#

This is very rarely altered for most use cases.

Configuration#

[Paths]

pydantic model eon.schema.PathsConfig[source]#

Show JSON schema

{
   "title": "PathsConfig",
   "type": "object",
   "properties": {
      "main_directory": {
         "default": "./",
         "description": "This is the root directory of the simulation. Configuration files and the initial reactant are here and by default all of the simulation data will be stored under this directory.",
         "title": "Main Directory",
         "type": "string"
      },
      "jobs_out": {
         "default": null,
         "description": "Directory for job outputs.",
         "title": "Jobs Out",
         "type": "string"
      },
      "jobs_in": {
         "default": null,
         "description": "Directory for job inputs.",
         "title": "Jobs In",
         "type": "string"
      },
      "incomplete": {
         "default": null,
         "description": "Directory for incomplete jobs.",
         "title": "Incomplete",
         "type": "string"
      },
      "states": {
         "default": null,
         "description": "Directory where all of the information about individual states is located.",
         "title": "States",
         "type": "string"
      },
      "results": {
         "default": null,
         "description": "Directory for storing results.",
         "title": "Results",
         "type": "string"
      },
      "potential_files": {
         "default": null,
         "description": "Directory for extra files needed by the client for the potential.",
         "title": "Potential Files",
         "type": "string"
      },
      "bh_minima": {
         "default": null,
         "description": "Directory for BH minima.",
         "title": "Bh Minima",
         "type": "string"
      },
      "kdb_scratch": {
         "default": null,
         "description": "Directory for KDB scratch files.",
         "title": "Kdb Scratch",
         "type": "string"
      },
      "kdb": {
         "default": null,
         "description": "Directory for KDB files.",
         "title": "Kdb",
         "type": "string"
      },
      "superbasins": {
         "default": null,
         "description": "Directory for superbasins.",
         "title": "Superbasins",
         "type": "string"
      },
      "superbasin_recycling": {
         "default": null,
         "description": "Directory for superbasin recycling.",
         "title": "Superbasin Recycling",
         "type": "string"
      },
      "scratch": {
         "default": null,
         "description": "Directory for scratch files.",
         "title": "Scratch",
         "type": "string"
      }
   }
}

Config:

use_attribute_docstrings: bool = True

Fields:

bh_minima (str)
incomplete (str)
jobs_in (str)
jobs_out (str)
kdb (str)
kdb_scratch (str)
main_directory (str)
potential_files (str)
results (str)
scratch (str)
states (str)
superbasin_recycling (str)
superbasins (str)

Validators:

set_default_paths » all fields

field bh_minima: str = None#

Directory for BH minima.

Validated by:

set_default_paths

field incomplete: str = None#

Directory for incomplete jobs.

Validated by:

set_default_paths

field jobs_in: str = None#

Directory for job inputs.

Validated by:

set_default_paths

field jobs_out: str = None#

Directory for job outputs.

Validated by:

set_default_paths

field kdb: str = None#

Directory for KDB files.

Validated by:

set_default_paths

field kdb_scratch: str = None#

Directory for KDB scratch files.

Validated by:

set_default_paths

field main_directory: str = './'#

This is the root directory of the simulation. Configuration files and the initial reactant are here and by default all of the simulation data will be stored under this directory.

Validated by: