Package wcdb :: Module models :: Class Simulation
[hide private]
[frames] | no frames]

Class Simulation

source code



Simulation 

Creation Arguments
    name                | type
    ----------------------------
    batch               | SimulationBatch
    batch_index         | Positive Integer
    states              | Dict String:Dict {"State name": PropertyDict,}
    length              | Float

    State Dict Format:
        {"State Name": 
            {"Property name": 
                (
                  (k0, k1, ..., kn, t), 
                  dtype
                )
            }
        }

    Where k0, ..., kn are Integers describing the shape of the property,
    and t is an Integer indicating how many time slices there will be.

Nested Classes [hide private]
  Meta
Instance Methods [hide private]
 
file_path(self)
The path to the HDF5 file for the Simulation
source code
 
h5file(self)
The H5Py File object for the Simulation HDF5 file
source code
 
lock_file(self)
Makes the file read only (when accessing through these models)
source code
 
__unicode__(self) source code
Class Variables [hide private]
  batch = models.ForeignKey('SimulationBatch', related_name= 'si...
  batch_index = models.PositiveIntegerField(default= 1, db_index...
  length = models.FloatField(null= True, blank= True, default= N...
  _file_permissions = models.CharField(max_length= 3, default= "a")
  objects = SimulationManager()
Method Details [hide private]

file_path(self)

source code 
The path to the HDF5 file for the Simulation 

Decorators:
  • @property_tag

h5file(self)

source code 
The H5Py File object for the Simulation HDF5 file 

Decorators:
  • @property_tag

Class Variable Details [hide private]

batch

Value:
models.ForeignKey('SimulationBatch', related_name= 'simulations')

batch_index

Value:
models.PositiveIntegerField(default= 1, db_index= True)

length

Value:
models.FloatField(null= True, blank= True, default= None)