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

lksearch should return either a file in the cache or an HDUList in memory #25

Open
5 tasks
christinahedges opened this issue Aug 22, 2024 · 0 comments
Open
5 tasks
Assignees
Labels
enhancement New feature or request

Comments

@christinahedges
Copy link
Collaborator

At the moment we have lksearch only returning files stored to disk, which was our first milestone. We now need a way to have lksearch return either a path to a file, or an astropy.fits.HDUlist in memory. Here are some scenarios;

  • User wants a TPF/LCF from Kepler/K2/TESS, wants and wants to cache that data for future use to prevent more queries. File should should be cached on disk. User could request either path to file, or astropy.fits.HDUList object in memory.
  • User wants a cut out TPF from the cubes, wants to cache that for future use to prevent more queries. File should be cached on disk. User could request either path to file, or astropy.fits.HDUList object in memory.
  • User wants a TPF/LCF/cut out TPF but does not need to cache it for the future (either won't need it, or are working on TiKE/AWS). File should not be cached on disk. User should only get an astropy.fits.HDUList object in memory.

We need the following

  • lksearch should have an option in the configuration on whether to cache files on disk. If no, lksearch would download data everytime. (This option needs )
  • The download functions in lksearch should have an option for what to return, either paths as a pd.DataFrame or an astropy.fits.HDUList.
  • In the event that any part of the download failed and the file is corrupted, download should raise an exception.
  • Using the configuration system, lksearch should be able to configure whether the default output of search is paths as a pd.DataFrame or an astropy.fits.HDUList. Sane default is probably astropy.fits.HDUList.
  • Using the configuration system, lksearch should be able to configure whether the default option is to cache files or not.

@tylerapritchard @Nschanche what's your take on this? Some of this might already exist inside lksearch.

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