Base

class casingSimulations.base.BaseCasing(**kwargs)

Bases: properties.base.base.HasProperties

Base class that contains working directories, code version and can be saved

Required Properties:

  • directory (String): Working directory, a unicode string, Default: .
  • filename (String): Filename to which the properties are serialized and written to, a unicode string
  • version (String): version of the software, a unicode string, Default: 0.0.4
copy()

Make a copy of the current casing object

directory

directory (String): Working directory, a unicode string, Default: .

filename

filename (String): Filename to which the properties are serialized and written to, a unicode string

save(filename=None, directory=None)

Save the casing properties to json :param str file: filename for saving the casing properties :param str directory: working directory for saving the file

version

version (String): version of the software, a unicode string, Default: 0.0.4

class casingSimulations.base.LoadableInstance(doc, instance_class, **kwargs)

Bases: properties.base.instance.Instance

class_info = 'an instance of a class or the name of a file from which the '
validate(instance, value)