emod_api.serialization.dtkFileTools module

Support for three formats of serialized population files: 1. “Original version”: single payload chunk with simulation and all nodes, uncompressed or snappy or LZ4 2. “First chunked version”: multiple payload chunks, one for simulation and one each for nodes 3. “Second chunked version”: multiple payload chunks, simulation and node objects are “root” objects in each chunk 4. “Metadata update”: compressed: true|false + engine: NONE|LZ4|SNAPPY replaced with compression: NONE|LZ4|SNAPPY

emod_api.serialization.dtkFileTools.uncompress(data, engine)

emod_api.serialization.dtkFileTools.compress(data, engine)

class emod_api.serialization.dtkFileTools.DtkHeader(dictionary=None)

Bases: SerialObject

class emod_api.serialization.dtkFileTools.DtkFile(header)

Bases: object

class Contents(parent)

Bases: object

append(item)

class Objects(parent)

Bases: object

append(item)

property header

property compressed

property compression

property byte_count

property chunk_count

property chunk_sizes

property author

property date

property tool

property version

property chunks

property nodes

class emod_api.serialization.dtkFileTools.DtkFileV1(header=None, filename='', handle=None)

Bases: DtkFile

property simulation

class emod_api.serialization.dtkFileTools.DtkFileV2(header=None, filename='', handle=None)

Bases: DtkFile

class NodesV2(parent)

Bases: object

property simulation

class emod_api.serialization.dtkFileTools.DtkFileV3(header=None, filename='', handle=None)

Bases: DtkFile

class NodesV3(parent)

Bases: object

property simulation

class emod_api.serialization.dtkFileTools.DtkFileV4(header=None, filename='', handle=None)

Bases: DtkFileV3

class emod_api.serialization.dtkFileTools.DtkFileV5(header=None, filename='', handle=None)

Bases: DtkFileV4

emod_api.serialization.dtkFileTools.read(filename)

emod_api.serialization.dtkFileTools.write(dtk_file, filename)