boxkit.api._read module

Module with implemenetation of api read methods

boxkit.api._read.read_dataset(filename, source=None, storage=None, server=None, force_memmap=False, nthreads=1, backend='serial', monitor=False, batch='auto')

Create a dataset from a file

Parameters

• filename (string containing file name) –

• source (string identifying source/format of the file) – ‘test-sample’ : method to create sample dataset for BoxKit API tests ‘flash’ : method to create FLASH dataset

• storage (storage option 'disk', 'pyarrow', or 'dask') – default(‘disk’)

• server (server dictionary) –

• force_memamp (flag) –

• nthreads (integer) –

• backend (string parameter for parallel backend) –

• monitor (flag) –

• references) ((see tests/boiling.py and tests/heater.py for) –

Return type

Dataset object