pysyncrosim.scenario.Scenario

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

A class representing a SyncroSim Scenario.

Methods

__init__

copy

Creates a copy of an existing Scenario class instance.

datasheets

Retrieves a DataFrame of Scenario Datasheets.

delete

Deletes a Scenario or data from a Scenario scope.

folders

Creates or retrieves a Folder in the parent Project of the Scenario.

ignore_dependencies

Retrieves or sets the Datafeeds to ignore for a Scenario.

merge_dependencies

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

results

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

run

Runs a Scenario.

run_log

Returns a run log for a Results Scenario.

save_datasheet

Saves a pandas DataFrame as a SyncroSim Datasheet.

Attributes

date_modified

Gets the last date this Scenario was modified.

dependencies

Retrieves the dependencies of a Scenario.

description

Gets or sets the Scenario description.

folder_id

Retrieves the ID of the folder the Scenario is contained within.

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.