|
| 1 | +This zip file contains a HydroShare resource in Bagit format. |
| 2 | + |
| 3 | +The data for the resource you downloaded is in the "data/contents" directory. |
| 4 | + |
| 5 | +The metadata for the resource is stored in the xml file "data/resourcemetadata.xml." |
| 6 | + |
| 7 | +A "resource" is the primary unit of content within HydroShare. Because resources may be made up of one or more files and may also have a hierarchical file/directory structure, HydroShare needed a way to consistently package resources for transport over the Internet. We use the BagIt file packaging format for this purpose. We chose BagIt because it is widely used by a number of organizations and online repositories involved in digital preservation, including the U.S. Library of Congress. |
| 8 | + |
| 9 | +You can find the full BagIt specification here: https://tools.ietf.org/html/draft-kunze-bagit-13. |
| 10 | + |
| 11 | +You can also find a much more detailed description of HydroShare's resource data model and packaging scheme in the following paper: |
| 12 | + |
| 13 | +Horsburgh, J. S., Morsy, M. M., Castronova, A., Goodall, J. L., Gan, T., Yi, H., Stealey, M. J., and D.G. Tarboton (2015). HydroShare: Sharing diverse hydrologic data types and models as social objects within a Hydrologic Information System, Journal Of the American Water Resources Association(JAWRA), https://doi.org/10.1111/1752-1688.12363. |
| 14 | + |
| 15 | +We've summarized the important points below. |
| 16 | + |
| 17 | +Zip File (the "bag") Structure |
| 18 | +-------------------------------------- |
| 19 | +Once you unzip the downloaded file, you should see a single folder. This folder is called the "base directory." The name of this folder is the resource's unique identifier in the HydroShare system. Within the base directory is the content of the resource. The following is an example of what you would get if you download a time series resource, but all resources use the same structure: |
| 20 | + |
| 21 | +1a25b11fa1354773b6edb9495e754f4e/ # Base directory |
| 22 | + bagit.txt # Tag file with BagIt version number |
| 23 | + manifest-md5.txt # Tag file with resource file manifest |
| 24 | + readme.txt # this readme file |
| 25 | + tagmanifest-md5.txt # Tag manifest file |
| 26 | + data/ # Payload directory |
| 27 | + resourcemap.xml # Resource map document |
| 28 | + resourcemetadata.xml # Resource-level metadata document |
| 29 | + visualization/ # Tag directory for thumbnail visualization |
| 30 | + thumbnail.jpg # Thumbnail visualization file |
| 31 | + contents/ # Tag directory containing content files |
| 32 | + ODM2.sqlite # Content file |
| 33 | + |
| 34 | +Zip File Content |
| 35 | +--------------------- |
| 36 | +The following are descriptions of each element of the resource bag: |
| 37 | + |
| 38 | +"1a25b11fa1354773b6edb9495e754f4e/" - This is the base directory named using the resource's HydroShare identifier. It is a container for the whole resource. |
| 39 | + |
| 40 | +"bagit.txt" - This text file specifies which version of the BagIt specification was used to create the bag. |
| 41 | + |
| 42 | +"manifest-md5.txt" - This is a manifest file that lists every file in the resource and provides a checksum for each file calculated using the MD5 algorithm. The file manifest and the checksums can be used to verify that all of the files within a resource have been retrieved with full integrity. |
| 43 | + |
| 44 | +"readme.txt" - This readme file describes the downloaded HydroShare resource bag. |
| 45 | + |
| 46 | +"tagmanifest-md5.txt" - This is a tag manifest file that lists tag files and their associated checksums calculated using the MD5 algorithm. |
| 47 | + |
| 48 | +"data/" - This subdirectory also called the "payload directory." All of the content files of the resource are stored within the "data" directory. |
| 49 | + |
| 50 | +"resourcemap.xml" - This XML document contains an Open Archives Initiative Object Reuse and Exchange (OAI-ORE) resource map. It is a list of all of the files within the resource and any relationships that exist between them. The purpose of this file is to enable a computer to discover the structure of the resource. |
| 51 | + |
| 52 | +"resourcemetadata.xml" - This XML document stores the main metadata for the resource. It contains at least the standard Dublin Core metadata elements and may contain additional metadata elements, depending on the resource type. |
| 53 | + |
| 54 | +"visualization/" - This is a subdirectory within which an optional thumbnail visualization of the resource may reside if present. |
| 55 | + |
| 56 | +"contents/" - This is the subdirectory within which the content files of the resource will be stored. There can be any number of folders/files within this subdirectory, depending on the required structure of the resource. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments