From c7389c3dbf9579e4876d82c0c2d0d76eed24aecb Mon Sep 17 00:00:00 2001 From: Aurelio Amerio Date: Wed, 28 Jun 2023 17:26:55 +0200 Subject: [PATCH] preparing for arxiv release, and fixing typos Update README.md Create README.md Update README.md Update pyproject.toml updated version and description Update README.md Update README.md Update README.md --- README.md | 10 +++++++--- pyproject.toml | 4 ++-- src/gPCS/data/fits/README.md | 2 ++ 3 files changed, 11 insertions(+), 5 deletions(-) create mode 100644 src/gPCS/data/fits/README.md diff --git a/README.md b/README.md index 22859b4..3ce6bc2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# gPCS +# gPCS: Gamma-ray Photon-Counts Statistics [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8070852.svg)](https://doi.org/10.5281/zenodo.8070852) [![Downloads](https://pepy.tech/badge/gPCS)](https://pepy.tech/project/gPCS) [![](https://img.shields.io/pypi/v/gPCS.svg?maxAge=3600)](https://pypi.org/project/gPCS) -This repository contains the code for the paper **Gamma-ray point-source catalogue from photon-count statistics**. +This repository contains the code for the paper **Deepening gamma-ray point-source catalogues with sub-threshold information**. -We provide our results in the form of a [precomputed FITS table](examples/firing_pixels.fits), as well as python package which can be used to read the data as `numpy` arrays, as well as export a similar FITS table. +We provide our results in the form of a [precomputed FITS](examples/firing_pixels.fits), as well as python package which can be used to read the data as `numpy` arrays, as well as export a similar FITS table. # Installation This package can easily be installed through pip: @@ -102,6 +102,10 @@ export_fits_table(filename, QF, alpha, overwrite=False, **kwargs) - QF_min : lower bound of the QF range - QF_max : upper bound of the QF range +In order to export the FITS table available in the examples folder, we can run the command +```python +gPCS.export_fits_table(filename="firing_pixels.fits", QF=0.50, alpha=[0.01, 0.05, 0.1]) +``` # List of functions - `get_QF_from_TS(TS, alpha)`: computes the quality factor from a given TS and alpha diff --git a/pyproject.toml b/pyproject.toml index 003e3f4..1e215ed 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "gPCS" -version = "1.0.1" +version = "1.0.2" authors = [ { name="Aurelio Amerio", email="aurelio.amerio@ific.uv.es" }, { name="Francesca Calore", email=""}, @@ -12,7 +12,7 @@ authors = [ { name="Bryan Zaldìvar", email=""} ] -description = "Code for the paper Gamma-ray point-source catalogue from photon-count statistics" +description = "Code for the paper Deepening gamma-ray point-source catalogues with sub-threshold information" dependencies = [ "numpy", "healpy", diff --git a/src/gPCS/data/fits/README.md b/src/gPCS/data/fits/README.md new file mode 100644 index 0000000..3e45163 --- /dev/null +++ b/src/gPCS/data/fits/README.md @@ -0,0 +1,2 @@ +4FGL-DR3 source catalogue provided by the Fermi-LAT collaboration. +The `gll_psc_v30.fit` file was retrieved from [https://fermi.gsfc.nasa.gov/ssc/data/access/lat/12yr_catalog/](https://fermi.gsfc.nasa.gov/ssc/data/access/lat/12yr_catalog/).