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

Feature-108: Citation Update Part 2 #146

Merged
merged 3 commits into from
Oct 1, 2024
Merged
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
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,27 @@
## HashStore: hash-based object storage for DataONE data packages

Version: 1.1.0
DOI: [doi:10.18739/A2ZG6G87Q](https://doi.org/10.18739/A2ZG6G87Q)

## Contributors

- **Author**: Dou Mok, Matthew Brooke, Jing Tao, Jeanette Clarke, Ian Nesbitt, Matthew B. Jones
- **License**: [Apache 2](http://opensource.org/licenses/Apache-2.0)
- [Package source code on GitHub](https://github.com/DataONEorg/hashstore)
- [**Submit Bugs and feature requests**](https://github.com/DataONEorg/hashstore/issues)
- Contact us: support@dataone.org
- [DataONE discussions](https://github.com/DataONEorg/dataone/discussions)

## Citation

Cite this software as:

> Dou Mok, Matthew Brooke, Jing Tao, Jeanette Clarke, Ian Nesbitt, Matthew B. Jones. 2024.
> HashStore: hash-based object storage for DataONE data packages. Arctic Data Center.
> [doi:10.18739/A2ZG6G87Q](https://doi.org/10.18739/A2ZG6G87Q)

## Introduction

HashStore is a server-side python package that implements an object storage file system for storing
and accessing data and metadata for DataONE services. The package is used in DataONE system
components that need direct, filesystem-based access to data objects, their system metadata, and
Expand Down Expand Up @@ -40,12 +55,12 @@ the expected usage of HashStore.
### Public API Methods

- store_object
- verify_object
- tag_object
- store_metadata
- retrieve_object
- retrieve_metadata
- delete_object
- delete_if_invalid_object
- delete_metadata
- get_hex_digest

Expand Down
Loading