pysyncrosim.project.Project

class pysyncrosim.project.Project(pid, name, library)

A class to represent a SyncroSim Project.

__init__(pid, name, library)

Initializes a pysyncrosim Project instance.

Parameters
  • pid (Int) – Project ID.

  • name (String) – Project name.

  • library (Library) – pysyncrosim Library instance.

Return type

None.

Methods

__init__(pid, name, library)

Initializes a pysyncrosim Project instance.

copy([name])

Creates a copy of an existing Project.

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

Retrieves a DataFrame of Project Datasheets.

delete([scenario, force])

Deletes a Project or Scenario.

run([scenarios, jobs, copy_external_inputs])

Runs a list of Scenario objects.

save_datasheet(name, data[, append, force])

Saves a Project-scoped Datasheet.

scenarios([name, sid, optional, summary, ...])

Retrieve a DataFrame of Scenarios in this Project.

Attributes

date_modified

Gets the last date this Project was modified.

description

Gets or sets the Project description.

info

Retrieves Project information.

library

Retrieves the Library the Project belongs to.

name

Retrieves or sets Project name.

owner

Gets or sets the owner of this Project.

pid

Retrieves Project ID.

readonly

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