3.1. Building a scenario and loading data — pyramses 0.0.22 3 (2024)

3.1.1. Initializing

We can initialize an instance of the test-case decriptor by importing pyramses and invoking the pyramses.cfg class of pyramses:

import pyramsescase = pyramses.cfg()

The available calls to the pyramses.cfg class are fully documented in Full list of functions. The most importantare detailed below.

3.1.2. Loading and saving test-case to configuration file

If a previously saved configuration file exists, it can be used to initialize the descriptor:

import pyramsescase = pyramses.cfg("cmd.txt") # where cmd.txt is the file with the test-case description

Similarly, a test-case can be saved into a configuration file:

case.writeCmdFile('cmd.txt') # where cmd.txt is the file with the test-case description

Many files can be loaded as follows:

import pyramseslist_of_cases = []for i in range(12): list_of_cases.append(pyramses.cfg('cmd'+str(i)+'.txt')) # loads 12 test-cases from files named 'cmd0.txt', ..., 'cmd11.txt'

Or saved:

for i in range(12): list_of_cases[i].writeCmdFile('cmd'+str(i)+'.txt') # saves 12 test-cases to files named 'cmd0.txt', ..., 'cmd11.txt'

3.1.3. Parameters

These are the different parameters that can be defined in the test-case description.

case.addData('data1.dat')case.addData('data2.dat')

case.delData('data1.dat')

case.getData()

case.clearData()

case.addInit('init.trace')

case.addDst('events.dst')

case.getDst()

case.clearDst()

case.addCont('cont.trace')

case.addDisc('disc.trace')

3.1.4. Full list of functions

class pyramses.cfg(cmd=None)[source]

Test case description class.

addCont(afile)[source]

Add contrinuous trace file

The continuous trace file saves information about the convergence of the solution algorithmused inside RAMSES. This is mainly used for debugging reasons and it can slow down the executionof the simulation.

Parameters

afile (str) – the filename. The complete path can be given or a the path relative to the working directory (os.getcwd())

Example

>>> import pyramses>>> case1 = pyramses.cfg()>>> case1.addCont("cont.trace")

Warning

If the file already exists, it will be ovewritten without warning!

addData(datafile)[source]

Add datafile in the dataset.

See Also

SOLVED: Each of the following programs or program segments has errors. Find as many as you can. A) fstream file(ios::in | ios::out); file.open("info.dat"); if (!file) cout « "Could not open file. In"; B) ofstream file; file.open("info.dat", ios::in); if

The data files provide a description of the system to be simulated, along with the solver parameters.

Parameters

datafile (str) – the filename. The complete path can be given or a the path relative to the working directory (os.getcwd())

Example

>>> import pyramses>>> case1 = pyramses.cfg()>>> case1.addData("dyn_A.dat")

Warning

At least one file needs to be added.

addDisc(afile)[source]

Add discrete trace file.

The discrete trace file saves information about the discrete events in the system, these may befrom the discrete controllers, events in the disturbance file, or from discrete variables insidethe injector, twoport, torque, or exciter models.

Parameters

afile (str) – the filename. The complete path can be given or a the path relative to the working directory (os.getcwd())

Example

>>> import pyramses>>> case1 = pyramses.cfg()>>> case1.addDisc("disc.trace")

Warning

If the file already exists, it will be ovewritten without warning!

addDst(dstfile)[source]

Add dstfile in the dstset

The disturbance file is where the disturbance to be simulated is described

Parameters

dstfile (str) – the filename. The complete path can be given or a the path relative to the working directory (os.getcwd())

Example

>>> import pyramses>>> case1 = pyramses.cfg()>>> case1.addDst("short.dst")

Warning

A file needs to be provided for the simulation to start.

addInit(afile)[source]

Define the file where the simulation initialization will be saved.

The initialization file is where the simulator will write the initialization procedure output.

Parameters

afile (str) – the filename. The complete path can be given or a the path relative to the working directory (os.getcwd())

Example

>>> import pyramses>>> case1 = pyramses.cfg()>>> case1.addInit("init.trace")

Warning

If the file already exists, it will be ovewritten without warning!

addObs(ofile)[source]

Add observables file

Parameters

ofile (str) – the filename. The complete path can be given or a the path relative to the working directory (os.getcwd())

Example

>>> import pyramses>>> case1 = pyramses.cfg()>>> case1.addObs("obs.dat")

addOut(afile)[source]

Define the file where the simulation output will be saved.

Parameters

afile (str) – the filename. The complete path must be given.

Example

>>> import pyramses>>> import os>>> case1 = pyramses.cfg()>>> case1.addOut(os.path.join(os.getcwd(),'output.trace'))

Note

If the file already exists, the output will be appended to that file.

addRunObs(runobs)[source]

Add runtime observable.

This defines some states that will be displayed during the simulation using gnuplot.

Parameters

runobs (str) – Description of runtime observable as defined in the RAMSES userguide

Example

• BV BUSNAME: Voltage magnitude of bus:

  >>> case.addRunObs('BV 1041') # observe the bus voltage of bus 1041

• MS SYNHRONOUS_MACHINE: Synchronous speed of machine:

  >>> case.addRunObs('MS g1')

• RT RT: Real-time vs simulated time plot:

  >>> case.addRunObs('RT RT')

• BPE/BQE/BPO/BQO BRANCH_NAME: Branch active (P), reactive (Q) power at the origin (O) or extremity (E) of a branch:

  >>> case.addRunObs('BPE 1041-01') # active power at the origin of branch 1041-01

• ON INJECTOR_NAME OBSERVABLE_NAME: Monitor a named observable from an injector

  >>> case.addRunObs('ON WT1a Pw') # observable Pw from injector WT1a

addTrj(afile)[source]

Add trajectory file

Parameters

afile (str) – the filename. The complete path can be given or a the path relative to the working directory (os.getcwd())

Example

>>> import pyramses>>> case1 = pyramses.cfg()>>> case1.addTrj("output.trj")

Warning

If the file already exists, it will be ovewritten without warning!

clearData()[source]

Empty the dataset

clearDisc()[source]

Clear discrete trace file

clearDst()[source]

Empty the dstset

clearRunObs()[source]

Clear runtime observables

delData(datafile)[source]

Remove a specific datafile from dataset

getCont()[source]

Return contrinuous trace file

Returns

name of file

Return type

str

getData()[source]

Get datafile list

Returns

list of data file names

Return type

list

getDisc()[source]

Return discrete trace file

Returns

name of discrete trace file

Return type

str

getDst()[source]

Get disturbance

Returns

name of disturbance file

Return type

str

getInit()[source]

Return initialization trace file

Returns

name of file

Return type

str

getObs()[source]

Get observables file name

Returns

name of observables file

Return type

str

getOut()[source]

Return output trace file

Returns

name of file

Return type

str

getTrj()[source]

Return trajectory file

Returns

name of file

Return type

str

writeCmdFile(userFile=None)[source]

Write command file.

Parameters

userFile (str) – The filename to write to (Optional). The complete path can be given ora the path relative to the working directory (os.getcwd()). If a file is not given, then atemporary is created and deleted when the object is destroyed.