calculate_neighbors#

Workflow for calculating neighbor connections.

Working location structure:

(name)
├── data
│   └── data.LOCATIONS
│       └── (name)_(key)_(seed).LOCATIONS.tar.xz
└── calculations
    └── calculations.NEIGHBORS
        └── (name)_(key)_(seed)_(tick).NEIGHBORS.csv

Data from data.LOCATIONS are used to calculate neighbors, which are saved to calculations.NEIGHBORS.

Flows

run_flow

Main calculate neighbors flow.

run_flow(context: ContextConfig, series: SeriesConfig, parameters: ParametersConfig) → None[source]#: Main calculate neighbors flow.

Configs

`ContextConfig`	Context configuration for calculate neighbors flow.
`ParametersConfig`	Parameter configuration for calculate neighbors flow.
`SeriesConfig`	Series configuration for calculate neighbors flow.

class ContextConfig[source]#

Context configuration for calculate neighbors flow.

working_location: str#: Location for input and output files (local path or S3 bucket).

class ParametersConfig[source]#

Parameter configuration for calculate neighbors flow.

key: str#: Simulation key to calculate.

seed: int#: Simulation random seed to calculate.

tick: int#: Simulation tick to calculate.

class SeriesConfig[source]#

Series configuration for calculate neighbors flow.

name: str#: Name of the simulation series.