collect_chandra_dois

Synopsis

A tool that scans a directory for Chandra data products and produces a list of data identifiers.

collect_chandra_dois  directory [--include] [--exclude]

Description

This tool is helpful to scientists who employ a large number of L2 observations and/or CSC data products in their publications to get an organized, comprehensive list of Chandra data identifiers for inclusion in the manuscript. Users can then send the CXC Archive team the output of this tool to be included in a Chandra Data Collection DOIs. The output of this tool can be used to fill the Chandra CXC Archive online form when requesting a new DOI to be generated.

Examples

Example 1

collect_chandra_dois .

Inspect the current directory, and any nested directories. Find all the *.fits and *.fits.gz files, and output all the Chandra Dataset IDS.

Example 2

collect_chandra_dois . --exclude '*ens000100*'

Inspect the current directory, and any nested directories. Do not include files whose names contain the 'ens000100' string, and output all the Chandra Dataset IDS.

Example 3

collect_chandra_dois . --include '**/*.fit'

Inspect the current directory, and any nested directories. Only include files with the .fit extension, and output all the Chandra Dataset IDS.

Parameters

Detailed Parameter Descriptions

Parameter=directory (string required filetype=input stacks=no)

Directory to search for FITS files. This is a positional argument and the only required argument.

The directory is searched recursively, i.e. nested directories are also searched, etc.

Parameter=--include (string not required filetype=input stacks=no)

Include file patterns.

Users can provide as many include patterns as necessary. The defaults are '**/*.fits' and '**/*.fits.gz'

Parameter=--exclude (string not required filetype=input stacks=no)

Exclude file patterns

Users can provide as many exclude patterns as necessary. The default is no patterns.

Changes in CIAO 4.17

• This tool will recursively scan the files in the input directory looking for the Chandra DS_IDENT keyword. It will generate a list of all the unique the Digital Object Identifier (DOI) values it discovers.