NIXIO Python library documentation¶
The NIXIO module is the native python re-implementation of the NIX C++ library for the NIX data model.
The NIX data model allows to store fully annotated scientific datasets, i.e. the data together with its metadata within the same container. Our aim is to achieve standardization by providing a common/generic data structure for a multitude of data types. See the wiki or the introduction for more information.
The current implementations store the actual data using the HDF5 file format as a storage backend.
NIX emerged from the activities of the Electrophysiology Task Force of the INCF Datasharing Program (2010-2015). It is a registered research resource with the RRID:SCR_016196.
Introduction¶
We have assembled introductory material that illustrates using nix. The tutorials contain several code examples. The use_cases explain in more detail how nix is used in real world situations.
Contributing & Governance¶
Any kind of contribution is welcome! This includes reporting bugs and issues. If you want to contribute to code or documentation please refer to the contributing guide.
License¶
This project is open source published under the BSD-3 license see license file for details.
Citing¶
If you use NIX, it would be much appreciated if you would cite it in publications with its identifier RRID:SCR_016196 and/or the reference:
Stoewer A, Kellner CJ, Benda J, Wachtler T and Grewe J (2014). File format and library for neuroscience data and metadata. Front. Neuroinform. Conference Abstract: Neuroinformatics 2014. doi: 10.3389/conf.fninf.2014.18.00027
Referenced by¶
Buccino et al. (2019) doi:10.1101/796599
Sprenger et al. (2019) doi:10.3389/fninf.2019.00062
Dragly et al (2018) doi:10.3389/fninf.2018.000169
Papez et al (2017) doi:10.3389/fninf.2017.00024
Grewe et al (2017) doi:10.1073/pnas.1615561114
Vanek et al (2016) doi:10.1109/informatics.2015.7377849
Rübel et al (2016) doi:10.3389/fninf.2016.00048
Denker et al (2016) doi:10.1007/978-3-319-50862-7_5
Teeters et al (2015) doi:10.1016/j.neuron.2015.10.025
Introduction
Tutorials
Troubleshooting:
Indices and tables¶
High Level API Reference¶
User API documentation for Data and Metadata
Advanced¶
Internal NIXIO API Developer Documentation¶
The API documentation of internal modules, for NIXPy developers.
Internal API
- nixio package
- Subpackages
- Submodules
- nixio.block module
- nixio.compression module
- nixio.container module
- nixio.data_array module
- nixio.data_frame module
- nixio.data_set module
- nixio.data_view module
- nixio.datatype module
- nixio.dimension_type module
- nixio.dimensions module
- nixio.entity module
- nixio.feature module
- nixio.file module
- nixio.group module
- nixio.info module
- nixio.link_type module
- nixio.multi_tag module
- nixio.property module
- nixio.section module
- nixio.source module
- nixio.source_link_container module
- nixio.tag module
- nixio.validator module
- Module contents