Broken/missing documentation of analysis

icecube / pisa

Monte Carlo-based data analysis

http://icecube.github.io/pisa/

Apache License 2.0

19 stars 47 forks source link

Broken/missing documentation of analysis #758

Closed LeanderFischer closed 2 months ago

LeanderFischer commented 10 months ago

The notebook in the analysis readme is missing. A working notebook and/or at least some sentences on how this should be used are needed.

atrettin commented 10 months ago

The README should refer to the documentation that is generated from the docstring: https://user-web.icecube.wisc.edu/~peller/pisa_docs/pisa.analysis.html#pisa.analysis.analysis.BasicAnalysis

ggarg07 commented 7 months ago

Hii @LeanderFischer.....so are you expecting a notebook to show how to use functions from analysis.py or something else? Can you please explicitly let me know?

thehrh commented 2 months ago

Close due to https://github.com/icecube/pisa/pull/781