1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
|
==================================
NIXIO Python library documentation
==================================
The NIXIO module is the native python re-implementation of the `NIX C++ library <https://nixio.readthedocs.io>`_ 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 <https://github.com/G-Node/nix/wiki>`__ or the
`introduction <getting_started.html>`__ for more information.
The current implementations store the actual data using the
`HDF5 <http://www.hdfgroup.org/>`__ file format as a storage backend.
*NIX* emerged from the activities of the Electrophysiology Task Force of
the `INCF <http://www.incf.org>`__ Datasharing Program (2010-2015). It
is a registered research resource with the
`RRID:SCR_016196 <https://scicrunch.org/resources/Any/record/nlx_144509-1/SCR_016196/resolver?q=SCR_016196&l=SCR_016196>`__.
Introduction
============
We have assembled `introductory material <getting_started.html>`__
that illustrates using nix. The tutorials contain several code
examples. `The use_cases <https://nixio.readthedocs.io/en/master/use_cases.html>`__ explain in more detail how
nix is used in real world situations.
Support
=======
If you need help, want to get in touch, or have any other request
`these <contact.html>`__ are your options.
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
=============
- Sinz et al. (2020)
`doi:10.1152/jn.00615.2019 <https://doi.org/10.1152/jn.00615.2019>`__
- Buccino et al. (2019)
`doi:10.1101/796599 <https://www.biorxiv.org/content/10.1101/796599v1>`__
- Sprenger et al. (2019)
`doi:10.3389/fninf.2019.00062 <https://doi.org/10.3389/fninf.2019.00062>`__
- Dragly et al (2018)
`doi:10.3389/fninf.2018.000169 <https://doi.org/10.3389/fninf.2018.000169>`__
- Papez et al (2017)
`doi:10.3389/fninf.2017.00024 <https://doi.org/10.3389/fninf.2017.00024>`__
- Grewe et al (2017)
`doi:10.1073/pnas.1615561114 <https://doi.org/10.1073/pnas.1615561114>`__
- Vanek et al (2016)
`doi:10.1109/informatics.2015.7377849 <https://doi.org/10.1109/informatics.2015.7377849>`__
- RĂ¼bel et al (2016)
`doi:10.3389/fninf.2016.00048 <https://doi.org/10.3389/fninf.2016.00048>`__
- Denker et al (2016)
`doi:10.1007/978-3-319-50862-7_5 <https://doi.org/doi:10.1007/978-3-319-50862-7_5>`__
- Teeters et al (2015)
`doi:10.1016/j.neuron.2015.10.025 <https://doi.org/doi:10.1016/j.neuron.2015.10.025>`__
.. toctree::
:caption: Introduction
:maxdepth: 1
basic_idea
install
standardization
Use-cases <https://nixio.readthedocs.io/en/master/use_cases.html>
.. toctree::
:maxdepth: 1
:caption: News
:hidden:
news
.. toctree::
:maxdepth: 1
:caption: Tutorials
getting_started
.. toctree::
:caption: Troubleshooting:
:maxdepth: 1
:hidden:
contact
faq
.. toctree::
:maxdepth: 1
:caption: API Reference
:hidden:
user_api
api/nixio
.. toctree::
:caption: Appendix
:maxdepth: 1
:hidden:
genindex
py-modindex
Sources on GitHub <https://github.com/g-node/nixpy>
License <https://github.com/G-Node/nixpy/blob/master/LICENSE>
Contributing guide <https://github.com/G-Node/nix/blob/master/CONTRIBUTING.md>
|