Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add citation information to README and readthedocs #477

Merged
merged 3 commits into from
Nov 30, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
- Fix bug in slicing tables with DynamicTableRegions. @ajtritt (#449)
- Add testing for Python 3.9 and using pre-release packages. @ajtritt, @rly (#459, #472)
- Improve contributing guide. @rly (#474)
- Add citation information to documentation. @rly (#477)

### Bug fixes
- Fix development package dependency issues. @rly (#431)
Expand Down
15 changes: 15 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,21 @@ Contributing

For details on how to contribute to HDMF see our `contribution guidelines <docs/CONTRIBUTING.rst>`_.

Citing HDMF
===========

.. code-block:: bibtex

@INPROCEEDINGS{9005648,
author={A. J. {Tritt} and O. {Rübel} and B. {Dichter} and R. {Ly} and D. {Kang} and E. F. {Chang} and L. M. {Frank} and K. {Bouchard}},
booktitle={2019 IEEE International Conference on Big Data (Big Data)},
title={HDMF: Hierarchical Data Modeling Framework for Modern Science Data Standards},
year={2019},
volume={},
number={},
pages={165-179},
doi={10.1109/BigData47090.2019.9005648}}

LICENSE
=======

Expand Down
14 changes: 10 additions & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,19 @@ The Hierarchical Data Modeling Framework

HDMF is a Python package for working with standardizing, reading, and writing hierarchical object data.

HDMF is a by product of the `Neurodata Without Borders: Neurophysiology (NWB:N) <http://www.nwb.org/>`_ project.
The goal of NWB:N was to enable collaborative science within the neurophysiology and systems neuroscience communities
through data standardization. The team of neuroscientists and software developers involved with NWB:N
HDMF is a by-product of the `Neurodata Without Borders: Neurophysiology (NWB) <http://www.nwb.org/>`_ project.
The goal of NWB was to enable collaborative science within the neurophysiology and systems neuroscience communities
through data standardization. The team of neuroscientists and software developers involved with NWB
recognize that adoption of a unified data format is an important step toward breaking down the barriers to
data sharing in neuroscience. HDMF was central the NWB:N development efforts, and has since been split off
data sharing in neuroscience. HDMF was central to the NWB development efforts, and has since been split off
with the intention of providing it as an open-source tool for other scientific communities.

If you use HDMF in your research, please use the following citation:

A. J. Tritt et al., "HDMF: Hierarchical Data Modeling Framework for Modern Science Data Standards,"
2019 IEEE International Conference on Big Data (Big Data), Los Angeles, CA, USA, 2019, pp. 165-179,
doi: 10.1109/BigData47090.2019.9005648.


.. toctree::
:maxdepth: 2
Expand Down
18 changes: 18 additions & 0 deletions docs/source/overview_citing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. _citing:

Citing HDMF
============

If you use HDMF in your research, please use the following citation:

.. code-block:: bibtex

@INPROCEEDINGS{9005648,
author={A. J. {Tritt} and O. {Rübel} and B. {Dichter} and R. {Ly} and D. {Kang} and E. F. {Chang} and L. M. {Frank} and K. {Bouchard}},
booktitle={2019 IEEE International Conference on Big Data (Big Data)},
title={HDMF: Hierarchical Data Modeling Framework for Modern Science Data Standards},
year={2019},
volume={},
number={},
pages={165-179},
doi={10.1109/BigData47090.2019.9005648}}