Skip to content

Commit 6a8b618

Browse files
authored
update README.md to include DOI information
1 parent afe2dd3 commit 6a8b618

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## A library for reading and writing binary physics data into a structured format.
44

5+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1479913.svg)](https://doi.org/10.5281/zenodo.1479913)
6+
57
One of the issues currently facing the physics community is the highly variable nature of experimental data formats. Analysis software is often tightly coupled to a particular binary data format. There may be many unique formats due to the nature of experimental design, or as a byproduct of the hardware available to researchers. This means that a great analysis tool that is available might be useless to you if your data is in the incorrect format. Simplifying the process of needing to integrate a unique data format into every piece of analysis code is therefore of great value.
68

79
This repository seeks to demonstrate and evaluate the use of existing tools to declaratively define the structure of binary data, in an effort to streamline user interaction with raw binary data. The tools currently being evaluated are Kaitai Struct and Daffodil. An extremely brief overview is given below:
@@ -12,4 +14,4 @@ Kaitai uses a yaml-style format to declare a binary format. The strength is that
1214

1315
### DFDL
1416

15-
DFDL takes a much different approach and serves directly as a parser instead of simply generating the code that the user must then incorporate. After declaring your format, DFDL parses the raw file and produces a new XML or JSON file. This file contains all the information in the raw file but has now been structure to be easily accessible. Nearly all programming languages have some type of XML or JSON parsing library which simplifies the process of accessing the relevant data. See the `dfdl/` folder for more information.
17+
DFDL takes a much different approach and serves directly as a parser instead of simply generating the code that the user must then incorporate. After declaring your format, DFDL parses the raw file and produces a new XML or JSON file. This file contains all the information in the raw file but has now been structure to be easily accessible. Nearly all programming languages have some type of XML or JSON parsing library which simplifies the process of accessing the relevant data. See the `dfdl/` folder for more information.

0 commit comments

Comments
 (0)