Skip to content

Commit

Permalink
more Zenodo updates
Browse files Browse the repository at this point in the history
  • Loading branch information
njsmith committed Aug 26, 2014
1 parent e9a8534 commit 887c045
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,26 @@ Contact:
Nathaniel J. Smith <[email protected]>

Citation:
If you use this software in work that leads to a scientific
publication, and feel that a citation would be appropriate, then
here is a possible citation:
If you use this software (or the ZS format in general) in
work that leads to a scientific publication, and feel that a
citation would be appropriate, then here is a possible citation:

Smith, N. J. (submitted). ZS: A file format for efficiently
distributing, using, and archiving record-oriented data sets of
any size. Retrieved from http://vorpus.org/papers/draft/zs-paper.pdf

In addition, if you wish to document exactly which version of this
software you used, then each official release has its own DOI which
you can find on the `change history page
<http://zs.readthedocs.org/en/latest/changes.html>`_.

It may make sense to cite either or both of these at the same time
-- the paper gives a general introduction to the ZS format and why
it is useful, the version-specific DOIs link directly to archived
snapshots of a specific version of this specific implementation of
the ZS format. FWIW, I personally benefit more from citations to the
paper.

Developer dependencies (only needed for hacking on source):
* Cython: needed to build from checkout
* nose: needed to run tests
Expand Down
6 changes: 6 additions & 0 deletions doc/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ v0.10.0
.. image:: https://zenodo.org/badge/doi/10.5281/zenodo.11445.png
:target: http://dx.doi.org/10.5281/zenodo.11445

|
Switched the default codec to LZMA, and dropped bzip2 support, since
LZMA seems as good or better on pretty much all axes.

Expand All @@ -19,4 +20,9 @@ Improved ``zs make``'s spinner output.
v0.9.0
------

.. image:: https://zenodo.org/badge/doi/10.5281/zenodo.11450.png
:target: http://dx.doi.org/10.5281/zenodo.11450


|
First public release.

0 comments on commit 887c045

Please sign in to comment.