Skip to content

Commit

Permalink
Add zenodo and citation information (#238)
Browse files Browse the repository at this point in the history
Co-authored-by: Wei Ji <[email protected]>
  • Loading branch information
andersy005 and weiji14 authored Sep 18, 2024
1 parent 504d293 commit 4723d00
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 1 deletion.
53 changes: 53 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
cff-version: 1.2.0

title: xbatcher
doi: 10.5281/zenodo.13776824
type: software
url: "https://github.com/xarray-contrib/xbatcher"
abstract: >-
Xbatcher is a small library for iterating Xarray DataArrays and Datasets in
batches. The goal is to make it easy to feed Xarray objects to machine
learning libraries such as PyTorch or TensorFlow.
keywords:
- Xarray
- Machine Learning
- Deep Learning
- PyTorch
- TensorFlow
- Dask
version: 0.4.0
date-released: 2024-09-17
message: "If you use this software, please cite it as below."
authors:
- family-names: Jones
given-names: Max
orcid: https://orcid.org/0000-0003-0180-8928
- family-names: Abernathey
given-names: Ryan
orcid: https://orcid.org/0000-0001-5999-4917
- family-names: Hamman
given-names: Joseph
orcid: https://orcid.org/0000-0001-7479-8439
- family-names: Banihirwe
given-names: Anderson
orcid: https://orcid.org/0000-0001-6583-571X
- family-names: Leong
given-names: Wei Ji
orcid: https://orcid.org/0000-0003-2354-1988
- family-names: Cindy
given-names: Chiao
- family-names: Bell
given-names: Ryan
- family-names: Hagen
given-names: Raphael
- family-names: Scott
given-names: Richard
- family-names: Bednar
given-names: James
- family-names: Vandal
given-names: TJ
- family-names: Bourbeau
given-names: James
- family-names: Jackson
given-names: Robert
5 changes: 4 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
xbatcher: Batch Generation from Xarray Datasets
===============================================

|Build Status| |codecov| |docs| |pypi| |conda-forge| |license|
|Build Status| |codecov| |docs| |pypi| |conda-forge| |license| |zenodo|


Xbatcher is a small library for iterating Xarray DataArrays and Datasets in
Expand Down Expand Up @@ -32,6 +32,9 @@ info.
.. |license| image:: https://img.shields.io/github/license/xarray-contrib/xbatcher.svg
:target: https://github.com/xarray-contrib/xbatcher
:alt: license
.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.13776824.svg
:target: https://doi.org/10.5281/zenodo.13776824
:alt: zenodo

Installation
------------
Expand Down
4 changes: 4 additions & 0 deletions doc/_static/switcher.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
"version": "latest",
"url": "https://xbatcher.readthedocs.io/en/latest/"
},
{
"version": "0.4.0",
"url": "https://xbatcher.readthedocs.io/en/v0.4.0/"
},
{
"version": "0.3.0",
"url": "https://xbatcher.readthedocs.io/en/v0.3.0/"
Expand Down

0 comments on commit 4723d00

Please sign in to comment.