Page History
...
| Feature/capability | Importance for MVP (must, should, nice) | Difficulty to deliver in MVP (high, medium,low) | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| user-friendly APIs | should | high | This is at least for a quick/dirty run. This might be similar to what Nimish Hathi mentioned. This concern is also including how data and processed data are encapsulated in variables inside the working environment (e.g., Jupyter). For example, considering the aXe outputs (check this ticket in Jira for some info
| ||||||||
| modularity | must | medium | This would be useful especially when we think of extendability either adding new grism definition from different facilities, or user customized objects from base classes. | ||||||||
| Interactive GUI | nice | high | Interactive graphic user interface will help users to quickly examine visually. | ||||||||
| documentation | must | medium | This is important, as we all can agree  | ||||||||
| minimal code comment standard | should | low | We should discuss about what would be the minimal requirement for code commenting. Have these requirements noted down, and make sure that all codes complied to the minimal standard before accepting any push to the main code body. We might assign someone specifically to go through all codes and check for the compliance. | ||||||||
| Tutorial / cookbook | must | low | This should explain itself how it import it is. | ||||||||
| minimal functionalities in prototype | must | medium | At minimum, the prototype should be able to take inputs = {a grism image or a set of dithered images, other association files... such as direct image, background image, etc.}, and give outputs. There should be APIs for users to easily re-run with different parameters (as compared to aXe, all outputs will be in OUTPUT folder, a user has to manage saving this folder separately in a different name, and re-run almost the whole codes just to produce outputs with different parameters. From my aXe experiences, I think extracting grism spectra composes of i) locating a spectrum, ii) compute trace and wavelength given a spectrum, iii) extract (in aXe sense, this is the SPC files), iv) post-extraction calibration (e.g., aperture correction, combining spectra with outlier detection and rejection algorithm in case use avoid performing extraction on a drizzled image, or flux scaled to photometric points... aXe does not perform these steps. | ||||||||
