pysyncrosim.scenario.Scenario

class pysyncrosim.scenario.Scenario(sid=None, name=None, project=None, library=None)

A class representing a SyncroSim Scenario.

__init__(sid=None, name=None, project=None, library=None)

Methods

__init__([sid, name, project, library])

copy([name])

Creates a copy of an existing Scenario class instance.

datasheet_rasters(datasheet[, column, ...])

Retrieves spatial data columns from one or more SyncroSim Datasheets.

datasheets([name, summary, optional, empty, ...])

Retrieves a DataFrame of Scenario Datasheets.

delete([force])

Deletes a Scenario.

dependencies([dependency, remove, force])

Gets, sets, or removes dependencies from a Scenario.

ignore_dependencies([value])

Retrieves or sets the Datafeeds to ignore for a Scenario.

merge_dependencies([value])

Retrieves or sets whether or not a Scenario is configured to merge dependencies at run time.

results([sid])

Retrieves DataFrame of Results Scenarios or retrieves a Results Scenario instance for this Scenario.

run([jobs, copy_external_inputs])

Runs a Scenario.

run_log()

Returns a run log for a Results Scenario.

save_datasheet(name, data)

Saves a pandas DataFrame as a SyncroSim Datasheet.

Attributes

date_modified

Gets the last date this Scenario was modified.

description

Gets or sets the Scenario description.

info

Retrieves Scenario information.

is_result

Retrieves information about whether this Scenario is a Results Scenario or not.

library

Retrieves Library class instance associated with this Library.

name

Retrieves or sets a Scenario name.

owner

Gets or sets the owner of this Scenario.

parent_id

Retrieves the ID of the parent Scenario of a Results Scenario.

project

Retrieves Project class instance associated with this Scenario.

project_id

Gets the Project ID associated with this Scenario.

readonly

Gets or sets the read-only status for this Scenario.

sid

Retrieves Scenario ID.