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

Add necessary documentation #26

Open
bryankim96 opened this issue Sep 14, 2018 · 2 comments
Open

Add necessary documentation #26

bryankim96 opened this issue Sep 14, 2018 · 2 comments
Assignees
Milestone

Comments

@bryankim96
Copy link
Member

bryankim96 commented Sep 14, 2018

In order to make the code more useful, the following documentation would be very useful:

  • An up-to-date and detailed description of the current cta-ml format (all tables, their purposes, the datatypes of each column, etc.). This is the most critical.
  • The version of ctapipe it is written for (as this is the key dependency and the most likely interface to change) This should be done after Update to use refactored ctapipe event routines #15.
  • Instructions for extending/modifying the code to handle new data formats (this will depend strongly on whether/when the rewrite in Refactoring to separate event/data loop from dumping to file #25 occurs).
  • Instructions on performance and mass processing. Given that this code is likely to be used to process large amounts of data, it would be useful to give instructions on how best to handle the procedure (multiple jobs/multithreading). Performance benchmarks could also be provided if available to give an idea of how long processing will take (per event).
  • Benchmarks on the effects of compression/chunking/indexing on write/read/search speed.

@nietootein @aribrill Anything else you can think of?

@bryankim96
Copy link
Member Author

  • An up-to-date and detailed description of the current cta-ml format (all tables, their purposes, the datatypes of each column, etc.). This is the most critical.

This page has now been updated for v0.7.2

This is now done in 1a7f685.

@TjarkMiener TjarkMiener added this to the v0.11.0 milestone Dec 10, 2021
@TjarkMiener
Copy link
Member

Sphinx documentation should be added.

@TjarkMiener TjarkMiener self-assigned this Dec 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants