Skip to content

Commit

Permalink
added examples to FileInfoTool
Browse files Browse the repository at this point in the history
  • Loading branch information
kosack committed Aug 3, 2023
1 parent 01ac44b commit 7639bbb
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions ctapipe/tools/fileinfo.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,17 @@ class FileInfoTool(Tool):
"""Extract metadata and other information from ctapipe output files"""

name = "ctapipe-fileinfo"
description = __doc__
examples = """To get YAML output of all metadata in HDF5 files in the
current directory
> ctapipe fileinfo *.h5
Generate an index table of all metadata: Note that you can
use any table format allowed by astropy.table. However, formats
with metadata like fits or ecsv are recommended.
> ctapipe fileinfo --output-table index.fits *.h5"""

input_files = traits.List(
traits.Path(exists=True, directory_ok=False),
Expand Down

0 comments on commit 7639bbb

Please sign in to comment.