Skip to content

Commit

Permalink
#161 Update demerge command help
Browse files Browse the repository at this point in the history
  • Loading branch information
astropenguin committed Jul 26, 2024
1 parent e23318b commit 28c7a23
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,19 @@ FLAGS
--data_dir=DATA_DIR
Type: Path
Default: PosixPath('.')
Path where raw data directory is placed,
Path of directory where data packages are placed,
i.e. expecting ``${data_dir}/cosmos_YYYYmmddHHMMSS``.
--dems_dir=DEMS_DIR
Type: Path
Default: PosixPath('.')
Path where merged DEMS file will be placed,
Path of directory where merged DEMS will be placed,
i.e. expecting ``${dems_dir}/dems_YYYYmmddHHMMSS.zarr.zip``.
--reduced_dir=REDUCED_DIR
Type: Path
Default: PosixPath('.')
Path where reduced data directory will be placed,
Path of directory where reduced packages are placed,
i.e. expecting ``${reduced_dir}/reduced_YYYYmmddHHMMSS``.
If not specified, a temporary directory will be used.
--ddb=DDB
Type: Path
Default: PosixPath('/path/to/demerge/data/ddb_20240713.fits')
Expand All @@ -60,7 +61,7 @@ FLAGS
--overwrite=OVERWRITE
Type: bool
Default: False
If True, reduced data directory and merged DEMS file
If True, the reduced package and the merged DEMS file
will be overwritten even if they exist.
--debug=DEBUG
Type: bool
Expand Down
2 changes: 1 addition & 1 deletion demerge/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ def demerge(
If not specified, a temporary directory will be used.
ddb: Path of DDB (DESHIMA database) file.
measure: Measure of the DEMS (either df/f or brightness).
overwrite: If True, reduced data directory and merged DEMS file
overwrite: If True, the reduced package and the merged DEMS file
will be overwritten even if they exist.
debug: If True, detailed logs for debugging will be printed.
**options: Other merge options for the merge command.
Expand Down

0 comments on commit 28c7a23

Please sign in to comment.