User Guide

Creating a database

To create a database, use the class Manager. A manager class takes a path name, schema name and unique identifier for a job: src.Manager.__init__() function:

To attach a parametric space to a job, initialize the manager class with parameters src.Manager.initialize() function:

• To register an output field, Manager class accepts a numpy array. One can describe as many output fields as one requires. In current version, an output field can either be scalar or 1D arrays. Make use of function src.Manager.registerQuantities() to register outfields.

• To push the output field values to the database, use the function `src.Manager.pushQuantity()

To finalize a run use the src.Manager.finalize() function:

Retrieving data

To retrieve data, use the class src.Digger.

• To list all the parametric points (or total jobs) within a schema, use the function src.Digger.showParametericSpace()

To chose a specific a point (or job) from the parameteric space, we provide a dedicated class Job.

• To choose a parameteric point, make use of the function src.Job.digID()

  Furthermore, to show the output fields present for the job, on can use src.Job.showDatabaseSpace() function

  To retreive, the data for a specific job, two function are provided. src.Job.digQuantityForJob() allows the user to retreive data for a specific output field only.

  In order to retreive the data for multiple output fields simulanteously, on can use the function src.Job.digQuantitiesForJob