You're reading the documentation for a development version. For the latest released version, please have a look at v0.5.

cwepr.io.exporter module

Exporters for both, whole datasets and data alone.

Exporters

There are two different general types of exporters provided: Exporters for whole datasets i.e. data with their according metadata and exporters for data only.

Warning

All metadata contained within a dataset (including the full history) are lost when exporting to plain text. Therefore, using this exporter will usually result in you loosing reproducibility. Hence, better think twice before using this exporter and use entirely on your own risk and only if you really know what you are doing (and why).

For further details and a comprehensive summary of data export, the reader is referred to the aspecd-documentation (aspecd.io).

If you want to export data to a txt-file, you might want to use the aspecd.io.TxtExporter.

class cwepr.io.exporter.ASCIIExporter

Bases: DatasetExporter

Export a dataset in ASCII format.

Exports the complete dataset to an ASCII file. At the same time, the respective metadata is exported into a YAML file using the functionality provided by aspecd. Metadata residing there as an object of the class numpy.ndarray are converted into lists.

A simple example for its usage looks like this:

datasets:
  - /path/to/first/dataset
  - /path/to/second/dataset

tasks:
  - kind: export
    type: ASCIIExporter
    properties:
      target:
        - dataset1
        - dataset2

Note

Not tested.

class cwepr.io.exporter.MetadataExporter

Bases: DatasetExporter

Export metadata to yaml file with default name.