Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the CLI intuitive #13

Open
15 tasks done
ijiraq opened this issue Aug 13, 2024 · 2 comments
Open
15 tasks done

Make the CLI intuitive #13

ijiraq opened this issue Aug 13, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@ijiraq
Copy link
Collaborator

ijiraq commented Aug 13, 2024

The CLI needs to be a little intuitive and clearly self documented. The options below are listed to meet the current requirements.

Implementation can use argparse package. LSST pipelines pass the argparse object around to various methods.

An approach that would allow a batch of objects to processed, where the options are the same for all objects and the objects are processed in parallel?

  • may accept options provided via an '@file'
  • may provide options as a .ecsv file
  • a series of one or more object names to do photometry on.
  • must use --help to provide a list of options and features.
  • --start-time [-s] for the starting time of when to search [can be in any valid astropy.time.Time format that is automatically parseable.
  • --end-time [-e] last date to search, same format rules as --start-time. [--end-time and --day-range are exclusive]
  • --day-range [-d] number of days to search forward from start time, can be -ve to specify days in the past
  • --max-search-ellipse [-x] maximum size of error ellipse that should be searched (3-sigma value) [User can give units?] (default of ??). [e.g. -x 10.2 arcsec ]
  • --min-cutout-size [-m] minimum size of cutout, maximum is error ellipse.
  • --ephemeris-service the name of the ephemeris service to use, from a choice list [Horizons, Skybot, .. ?]
  • --image-service the name of the image service to use, from a choice list [LSST-Butler, ZTF, ]
  • --catalog-service the name of the ephemeris service to use, from a choice list [LSST-TAP, ZTF, ?]
  • --photometry-service name of the forced photometry package to use [https://github.com/rubin-dp0/tutorial-notebooks/blob/main/DP02_05_Source_Detection_and_Measurement.ipynb]
  • --threshold the limit at which to attempt to do force photometry (SNR , default = 3?)
  • --return-cutouts should we return a cutout. (default == FALSE)
@ijiraq ijiraq added the enhancement New feature or request label Aug 13, 2024
@carrholt
Copy link
Collaborator

For the --min-cutout-size, is there a reason this is not just a defined cutout size? I'm unsure what the reason is for having a maximum/minimum? And I also feel like the maximum of the error ellipse is too small for well defined orbits.

@carrholt
Copy link
Collaborator

I'm unsure of the --max-search-ellipse as well. Why is this a maximum rather than a defined value? And what is the purpose of specifying 3-sigma here? I would imagine the default search ellipse to be the 3-sigma value given by Horizons during the ephemeris query. Maybe that is where the 3-sigma came from, but I don't think that would apply to a user input.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants