Add scripts/READMD_write_gcr_to_parquet.md

LSSTDESC / DC2-production

Configuration, production, validation specifications and tools for the DC2 Data Set.

BSD 3-Clause "New" or "Revised" License

11 stars 7 forks source link

Add scripts/READMD_write_gcr_to_parquet.md #415

Closed yymao closed 3 years ago

yymao commented 3 years ago

@heather999 has asked me to update scripts/README.md but the content is somewhat outdated and the file also seems to more like a log than instructions.

I hence created a new file scripts/READMD_write_gcr_to_parquet.md to document how to use write_gcr_to_parquet.py. The procedures listed in this new file are what I used to generate the public release DPDD catalog.

yymao commented 3 years ago

Thanks, @JoanneBogart. If I didn't miss anything, you have three suggestions (in addition to those you use GitHub's suggestion mode, which I have already all accepted):

Add how to run on a single tract or small number of identified tracts
Change the text "generally speaking"
Say what happen when --output-filename is not specified

I have addressed all of them now.