Example tutorial notebook to create flux and spectral parameters light-curve of a GRB

[ldigesu]

In this fork, I added an example jupyter notebook in the docs/tutotial folder that:

-slices the COSI dataset of a GRB in time.
-fits each time slice of data using 3ML
-creates and plots time-series of fluxes, counts and fitted spectral parameters.

[codecov]

Codecov Report

Attention: Patch coverage is 18.07229% with 204 lines in your changes missing coverage. Please review.

Project coverage is 75.91%. Comparing base (aea580b) to head (28eefc5).
Report is 16 commits behind head on develop.

Files with missing lines	Patch %	Lines
cosipy/pipeline/src/spec_func.py	0.00%	154 Missing ⚠️
cosipy/pipeline/task/task.py	0.00%	47 Missing ⚠️
cosipy/response/FullDetectorResponse.py	93.61%	3 Missing ⚠️

❌ Your patch check has failed because the patch coverage (18.07%) is below the target coverage (100.00%). You can increase the patch coverage or adjust the target coverage.

Files with missing lines	Coverage Δ
cosipy/response/ExtendedSourceResponse.py	91.17% <100.00%> (+0.26%)	⬆️
cosipy/response/FullDetectorResponse.py	49.71% <93.61%> (+10.42%)	⬆️
cosipy/pipeline/task/task.py	0.00% <0.00%> (ø)
cosipy/pipeline/src/spec_func.py	0.00% <0.00%> (ø)

... and 2 files with indirect coverage changes

[israelmcmc]

@ldigesu Thank you for adding this! I haven't run it or looked at the code in detail (any takers?), but I have a small comment based on the list of files changed. Did you intend to commit the PDF files? It seems those are outputs of jupyter notebook, and probably shouldn't be part of the repo.

[ldigesu]

@ldigesu Thank you for adding this! I haven't run it or looked at the code in detail (any takers?), but I have a small comment based on the list of files changed. Did you intend to commit the PDF files? It seems those are outputs of jupyter notebook, and probably shouldn't be part of the repo.

Hello, I committed them because otherwise, it would not create the directory for the outputs. But yes, the pdf files are not necessary. For the review, maybe Eliza is a good candidate because I mostly built up using her code. Or Srinadh. cheers,

[israelmcmc]

Thanks @ldigesu.

I committed them because otherwise, it would not create the directory for the outputs. But yes, the pdf files are not necessary.
I see. One options is to create the folder with os' or pathlib's mkdir function instead.

For the review, maybe Eliza is a good candidate because I mostly built up using her code. Or Srinadh
Yeah, I agree. This could be a good review for Srinadh. @srinadh99, what do you think? I can help with the revew process if you want.