πŸ”Œ Application Programming Interface

πŸ”Œ Application Programming Interface#

galactic.io.data.burmeister module

Class

class BurmeisterDataReader#

Bases: object

Μ€Burmeister data reader.

Example

>>> from galactic.io.data.burmeister import BurmeisterDataReader
>>> reader = BurmeisterDataReader()
>>> import io
>>> text = '''B
...
... 2
... 2
...
... 1
... 2
... a
... b
... .X
... XX
... '''
>>> dataset = reader.read(io.StringIO(text))
>>> {key: dict(data) for key, data in dataset.items()}
{'1': {'a': False, 'b': True}, '2': {'a': True, 'b': True}}

Notes

See also https://upriss.github.io/fca/fcafileformats.html#Burmeister

extensions()#

Return an iterator over the supported extensions.

Returns:

An iterator over the supported extensions

Return type:

Iterator[str]

read(data_file)#

Read a Burmeister data file.

Parameters:

data_file (TextIO) – A readable text file

Returns:

The data set read from the file.

Return type:

DataSet

Raises:

RuntimeError – If the Burmeister HEADER is not detected

register()#

Register an instance of a Burmeister data reader.

Return type:

None

Contents