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={'author': 'unknown', 'bytecount': 0, 'chunkcount': 0, 'chunksizes': [], 'compressed': True, 'date': 'Thu Jun 17 21:35:27 2021', 'engine': 'LZ4', 'tool': 'dtkFileTools.py', 'version': 1})

Bases: emod_api.serialization.dtkFileSupport.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={'author': 'unknown', 'bytecount': 0, 'chunkcount': 0, 'chunksizes': [], 'compressed': True, 'date': 'Thu Jun 17 21:35:27 2021', 'engine': 'LZ4', 'tool': 'dtkFileTools.py', 'version': 1}, filename='', handle=None)

Bases: emod_api.serialization.dtkFileTools.DtkFile

property simulation

class emod_api.serialization.dtkFileTools.DtkFileV2(header={'author': 'unknown', 'bytecount': 0, 'chunkcount': 0, 'chunksizes': [], 'compressed': True, 'date': 'Thu Jun 17 21:35:27 2021', 'engine': 'LZ4', 'tool': 'dtkFileTools.py', 'version': 1}, filename='', handle=None)

Bases: emod_api.serialization.dtkFileTools.DtkFile

class NodesV2(parent)

Bases: object

property simulation

class emod_api.serialization.dtkFileTools.DtkFileV3(header={'author': 'unknown', 'bytecount': 0, 'chunkcount': 0, 'chunksizes': [], 'compressed': True, 'date': 'Thu Jun 17 21:35:27 2021', 'engine': 'LZ4', 'tool': 'dtkFileTools.py', 'version': 1}, filename='', handle=None)

Bases: emod_api.serialization.dtkFileTools.DtkFile

class NodesV3(parent)

Bases: object

property simulation

class emod_api.serialization.dtkFileTools.DtkFileV4(header={'author': 'unknown', 'bytecount': 0, 'chunkcount': 0, 'chunksizes': [], 'compressed': True, 'date': 'Thu Jun 17 21:35:27 2021', 'engine': 'LZ4', 'tool': 'dtkFileTools.py', 'version': 1}, filename='', handle=None)

Bases: emod_api.serialization.dtkFileTools.DtkFileV3

emod_api.serialization.dtkFileTools.read(filename)

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