coexist.access.AccessPaths

class coexist.access.AccessPaths(directory: Optional[str] = None, results: Optional[str] = None, outputs: Optional[str] = None, script: Optional[str] = None, setup: Optional[str] = None, epochs: Optional[str] = None, epochs_scaled: Optional[str] = None, history: Optional[str] = None, history_scaled: Optional[str] = None)

Bases: object

Structure handling IO and storing all paths relevant for an ACCES run.

Loading and saving epochs and history are handled too.

Attributes:

directorystr

Path to the ACCES directory, e.g. access_seed123.

resultsstr

Path to the results directory.

outputsstr

Path to the outputs directory.

scriptstr

Path to the ACCES-modified user script.

setupstr

Path to the saved ACCES setup.

epochsstr

Path to the epochs CSV data file.

epochs_scaledstr

Path to the scaled epochs CSV data file.

historystr

Path to the historical CSV data file.

history_scaledstr

Path to the scaled historical CSV data file.

__init__(directory: Optional[str] = None, results: Optional[str] = None, outputs: Optional[str] = None, script: Optional[str] = None, setup: Optional[str] = None, epochs: Optional[str] = None, epochs_scaled: Optional[str] = None, history: Optional[str] = None, history_scaled: Optional[str] = None)

Methods

__init__([directory, results, outputs, ...])
copy()	Create a copy of an AccessPaths object.
create_directories(access)	Given a coexist.Access instance, create the required directory hierarchy for a single ACCES run.
load_epochs(access)	Given an Access instance, load previous ACCES runs' epochs and epochs_scaled into access.progress.
load_history(access)	Load previous results into access.progress.
save_epochs(setup, progress)	Given an AccessSetup and AccessProgress instance, save the optimisation epochs.
save_history(setup, progress)	Given an AccessSetup and AccessProgress instance, save the results history.
update_paths(prefix)	Translate all paths saved in this class relative to a new prefix (which will replace the directory attribute).

create_directories(access)

Given a coexist.Access instance, create the required directory hierarchy for a single ACCES run.

update_paths(prefix)

Translate all paths saved in this class relative to a new prefix (which will replace the directory attribute).

Please ensure that the prefix directory contains the required ACCES files.

save_history(setup, progress)

Given an AccessSetup and AccessProgress instance, save the results history.

load_history(access)

Load previous results into access.progress.

save_epochs(setup, progress)

Given an AccessSetup and AccessProgress instance, save the optimisation epochs.

load_epochs(access)

Given an Access instance, load previous ACCES runs’ epochs and epochs_scaled into access.progress.

copy()

Create a copy of an AccessPaths object.