Skip to content

Commit

Permalink
Better document command-line examples to run to test.
Browse files Browse the repository at this point in the history
  • Loading branch information
wmwv committed Jul 19, 2024
1 parent 39b6673 commit af26ba7
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,15 @@ ${DATADIR}/truth/H158/42193/Roman_TDS_index_H158_42193_1.txt
Install required packages. See `requirements_conda.txt` and `requirements_pip.txt` for the respective requirements. (Not all needed packages are available via Conda).


On NERSC
```
INFODIR=/pscratch/sd/w/wmwv/RomanDESC
DATADIR=/pscratch/sd/w/wmwv/RomanDESC
transient_id=41024123441
python RomanDESCForwardModelLightcurves.py ${transient_id} --datadir ${DATADIR}
python RomanDESCForwardModelLightcurves.py ${transient_id} --infodir ${INFODIR} --datadir ${DATADIR} --dataset RomanDESC
```

A general test example script. Update the variables in the script to match your local system locations for DATADIR.
```
sh tests/test_one_lightcurve.sh
```
18 changes: 15 additions & 3 deletions tests/test_one_lightcurve.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Change this to what the RomanDESCSims data are.
# Below DATADIR should be the subdirectories 'images' and 'truth'.
# A general test example script.
# Update the variables in the script to match your local system locations for DATADIR.
# In DATADIR should be the subdirectories 'images' and 'truth'.
DATADIR=${HOME}/data/RomanDESCSims

# In INFODIR should be transient_info_table.csv
# transient_host_info_table.csv
# We have these in tests/data for a few transients, so we can use those to test
INFODIR=tests/data/RomanDESC
DATASET=RomanDESC
oid=41024123441
# Run from base directoroy
python python/RomanDESCForwardModelLightcurves.py 41024123441 --infodir tests/data/RomanDesc --datadir ${DATADIR} --dataset RomanDESC
python python/RomanDESCForwardModelLightcurves.py \
${oid} \
--infodir ${INFODIR} \
--datadir ${DATADIR} \
--dataset ${DATASET}

0 comments on commit af26ba7

Please sign in to comment.