Classipygrb

**Welcome to ClassiPyGRB**

ClassiPyGRB is a Python 3 package to download, process, visualize and classify Gamma-Ray-Bursts (GRBs) from the [Swift/BAT Telescope](https://swift.gsfc.nasa.gov/about_swift/bat_desc.html) database. It is distributed over the GNU General Public License Version 2 (1991). Please, read the complete description of the method and its application to GRBs in this [publication](https://github.com/KenethGarcia/ClassiPyGRB/blob/master/JOSS_Docs/paper.md).

The current version of ClassiPyGRB is optimized to work with $64$ ms and $10$ s binning data. However, you can use all the instances in more cases, as $16$ ms or $1$ s. This package represent a generalization of the work of [Garcia-Cifuentes et al.(2023)](https://arxiv.org/abs/2304.08666) with a background scheme of functions to work with Swift/BAT data.

Compared with previous versions, the version 1.0.0 improves/add:

1. The overall structure of all the modules, functions and instances or previous versions.
2. A detailed docstrings in each module, function and instance for an easy-to-follow reading
3. A testing platform. Now it covers an automated workflow to test the principal components of ClassiPyGRB, and a step-to-step documentation, to allow the user test the results obtained.
4. A detailed documentation, covering all the instances and modules of ClassiPyGRB.
5. A simple Graphical User Interface summarizing the embeddings obtained, visualize light curves and Fourier spectrums of each Gamma-Ray-Burst.
6. New features, as flux and hardness ratio estimation from light curves.

Check the docs section to see what you can do with ClassiPyGRB.

Main Changes
- Added flux_calculator instance. It calculates the total flux in any band for the entire or a part of the light curve.
- Added hardness_proxy instance. It calculates the flux ratio of the 50–100
and 25–50 keV bands (a proxy for hardness) for any GRB in Swift Data.
- Added nearest_neighbors instance. It calculates the n nearest neighbors for any GRB in the resulting t-SNE visualization map.
Minor Changes
- Change the Interpolation Settings Path from "/" to "\"; following Linux indexing.

In this version, we made minor changes to the repository:

- Removed old README.md
- Updated Documentation section
- Added more animations and images

Main changes

1. Added Documentation section for more flexibility
2. Added Non-parametric noise reduction to data
3. Added interpolation to data
4. Improved parallelization using repeat itertools package
5. Removed Pre-processing bugs when changing resolution in normalize function
6. Separate concatenate from DFT (useful when you don't need DFT in pre-processing)
7. Added background GRB plotting (used when interpolating)

Minor changes

- Updated docstrings
- Updated animations
- Refined DFT plot by using fftshift from scipy

Thanks to Carlos del Burgo from INAOE for the FABADA noise filtering recommendation.