pds4-tools/src/collection-builder/README.md

Tools to generate and use PDS4 metadata.

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

pds-collection-builder
==========================
Build a collection inventory file and optional update a collection label.

Extract information from a PDS4 labels in a directory and generate a collection
inventory. If supplied an existing collection label the label will be updated to
match the generated collection inventory file information.

When a collection label is provided the tool will update the Time_Coordinates.start_date_time, Time_Coordinates.stop_date_time and File_Area_Inventory.File information based on information found during the scan. It will also replace the contents Primary_Results_Summary, Target_Information and Observing_System with a roll-up of information found in each of these sections in the data products.

## Installation
"pds-doi-request" is part of the "pds4-tools" package and can be installed with from NPM.

```
npm install pds4-tools -g
```

## Usage

```
pds-collection-builder [args] <directory>
```

## Options

<dl>
  <dt>--version</dt><dd>Show version number                                [boolean]</dd>
  <dt>-h, --help</dt><dd>Show information about the app.                    [boolean]</dd>
  <dt>-v, --verbose</dt><dd>Show progress and other performance information.   [boolean]</dd>
  <dt>-i, --id</dt><dd>Logical ID for the collection.      [string] [default: ""]</dd>
  <dt>-d, --version</dt><dd>Version ID for the collection.      [string] [default: ""]</dd>
  <dt>-c, --collection</dt><dd>File name of the collection label.    [string] [default: ""]</dd>
  <dt>-o, --output</dt><dd>Output file name for collection inventory.
                                                          [string] [default: ""]</dd>
</dl>

## Examples

- Generate a collection index for products in the current directory that belong to the collection 'urn:nasa:pds:maven.static.c:data.2a_hkp' and write inventory in "collection.csv".

```
  pds-collection-builder -i urn:nasa:pds:maven.static.c:data.2a_hkp -o collection.csv .
```

- Update a collection product label with a fresh generation of a collection index. The collection ID in the collection label will be used to determine which products to include in the collection inventory. The collection index will be written into the file referenced in the collection label. 

```
  pds-collection-builder -c collection.xml .
```

- Generate a collection index for products in the current directory that belong to the collection 'urn:nasa:pds:maven.static.c:data.2a_hkp', write inventory in "collection.csv" and update the collection label 'collection.xml' with the roll-up of information from the products.

The 'collection.xml' could be a partially complete collection label such as the example [collection-label-example.xml(collection-label-example.xml).

```
  pds-collection-builder -i urn:nasa:pds:maven.static.c:data.2a_hkp -o collection.csv -c collection.xml .
```

## License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

[http://www.apache.org/licenses/LICENSE-2.0](https://opensource.org/licenses/Apache-2.0)

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
 limitations under the License.