From 3a97767d6288c1e2e9ada39c37626a368d9e865d Mon Sep 17 00:00:00 2001 From: Andrey Mukhin Date: Fri, 9 Sep 2022 16:28:54 +0300 Subject: [PATCH 1/8] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 58d9256..637fb10 100644 --- a/README.md +++ b/README.md @@ -1 +1,8 @@ # nuwavsource +##Installation +This package is to be used with Python 3.x.x +To install tha package write +'pip install nuwavsource' +##Usage +To use the package in your project, import it in by writing +'from nuwavsource import nuwavsource' From 3add6c013c8a1d142d2ad7cd846deb89393ced5a Mon Sep 17 00:00:00 2001 From: Andrey Mukhin Date: Fri, 9 Sep 2022 16:29:29 +0300 Subject: [PATCH 2/8] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 637fb10..e29aa8d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # nuwavsource -##Installation +## Installation This package is to be used with Python 3.x.x To install tha package write 'pip install nuwavsource' -##Usage +## Usage To use the package in your project, import it in by writing 'from nuwavsource import nuwavsource' From 5af064884d55112b522c5c65cd34ba6f3179ea91 Mon Sep 17 00:00:00 2001 From: Andrey Mukhin Date: Fri, 9 Sep 2022 16:31:03 +0300 Subject: [PATCH 3/8] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e29aa8d..a3cc127 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Installation This package is to be used with Python 3.x.x To install tha package write -'pip install nuwavsource' +`pip install nuwavsource` ## Usage To use the package in your project, import it in by writing -'from nuwavsource import nuwavsource' +`from nuwavsource import nuwavsource` From 4fb0fe733bd2c41ef1d4ad37579aa7cbdb1d780f Mon Sep 17 00:00:00 2001 From: Andrey Mukhin Date: Fri, 9 Sep 2022 16:42:05 +0300 Subject: [PATCH 4/8] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index a3cc127..73ced59 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ # nuwavsource + +This package is supposed to be used to detect the sources in NuStar observations and generate a mask excluding the signal from the sources of any kind. Additionaly, it generates a table containing useful data about the observation(OBS_ID, Detector, coordinates in equatorial (ra,dec) and galactical (lon,lat) systems, time of the observation in seconds, exposure) and useful algorythm-related data (average count rate on unmasked area, portion of unmasked area, specific statistical metric[1] before and after masking the detected sources and root-mean-square of counts in unmasked area) + ## Installation This package is to be used with Python 3.x.x + To install tha package write + `pip install nuwavsource` + ## Usage + To use the package in your project, import it in by writing + `from nuwavsource import nuwavsource` + +The list of useful tools in this package is From 4730870f16cd3f751096245bd93b77e9e91a72e3 Mon Sep 17 00:00:00 2001 From: Andrey Mukhin Date: Fri, 9 Sep 2022 16:45:19 +0300 Subject: [PATCH 5/8] Update README.md --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 73ced59..ffd81e3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,20 @@ # nuwavsource -This package is supposed to be used to detect the sources in NuStar observations and generate a mask excluding the signal from the sources of any kind. Additionaly, it generates a table containing useful data about the observation(OBS_ID, Detector, coordinates in equatorial (ra,dec) and galactical (lon,lat) systems, time of the observation in seconds, exposure) and useful algorythm-related data (average count rate on unmasked area, portion of unmasked area, specific statistical metric[1] before and after masking the detected sources and root-mean-square of counts in unmasked area) +This package is supposed to be used to detect the sources in NuStar observations and generate a mask excluding the signal from the sources of any kind. + +Additionaly, it generates a table containing: +Useful data about the observation: +1. OBS_ID +2. Detector +3. coordinates in equatorial (ra,dec) and galactical (lon,lat) systems +4. time of the observation in seconds +5. exposure + +Useful algorythm-related data: +6. average count rate on unmasked area +7. portion of unmasked area +8. specific statistical metric[1] before and after masking the detected sources +9. root-mean-square of counts in unmasked area ## Installation This package is to be used with Python 3.x.x From fcff673291f429e5d982d726778af721d7c69ebf Mon Sep 17 00:00:00 2001 From: Andrey Mukhin Date: Fri, 9 Sep 2022 16:53:21 +0300 Subject: [PATCH 6/8] Update README.md --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ffd81e3..971e199 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,17 @@ This package is supposed to be used to detect the sources in NuStar observations and generate a mask excluding the signal from the sources of any kind. Additionaly, it generates a table containing: + Useful data about the observation: + 1. OBS_ID 2. Detector -3. coordinates in equatorial (ra,dec) and galactical (lon,lat) systems -4. time of the observation in seconds -5. exposure +3. Coordinates in equatorial (ra,dec) and galactical (lon,lat) systems +4. Time of the observation in seconds +5. Exposure Useful algorythm-related data: + 6. average count rate on unmasked area 7. portion of unmasked area 8. specific statistical metric[1] before and after masking the detected sources @@ -29,4 +32,12 @@ To use the package in your project, import it in by writing `from nuwavsource import nuwavsource` -The list of useful tools in this package is +You can process the cl.evt file by creating an Observation class object: + +`obs = nuwavsource.Observation(path_to_evt_file)` + +Additionally, the energy band to get events from can be passed as an argument: + +`obs = nuwavsource.Observation(path_to_evt_file,E_borders=[E_min,E_max])` + +The default value used in the code is [3,20] From c447a3d357807f2e005ee4888a3b4c1ead799584 Mon Sep 17 00:00:00 2001 From: Andrey Mukhin Date: Fri, 9 Sep 2022 17:26:39 +0300 Subject: [PATCH 7/8] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 971e199..30067bb 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,10 @@ Useful data about the observation: Useful algorythm-related data: -6. average count rate on unmasked area -7. portion of unmasked area -8. specific statistical metric[1] before and after masking the detected sources -9. root-mean-square of counts in unmasked area +6. Average count rate on unmasked area +7. Portion of unmasked area +8. Specific statistical metric[1] before and after masking the detected sources +9. Root-mean-square of counts in unmasked area ## Installation This package is to be used with Python 3.x.x From bddde49cd6ae85a67c4775f47a86f89dd625d140 Mon Sep 17 00:00:00 2001 From: Andrey Mukhin Date: Fri, 9 Sep 2022 17:31:21 +0300 Subject: [PATCH 8/8] Update README.md --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 30067bb..53fb863 100644 --- a/README.md +++ b/README.md @@ -24,20 +24,26 @@ This package is to be used with Python 3.x.x To install tha package write -`pip install nuwavsource` +```bash +pip install nuwavsource +``` ## Usage To use the package in your project, import it in by writing -`from nuwavsource import nuwavsource` +```python +from nuwavsource import nuwavsource +``` You can process the cl.evt file by creating an Observation class object: -`obs = nuwavsource.Observation(path_to_evt_file)` +```python +obs = nuwavsource.Observation(path_to_evt_file) +``` -Additionally, the energy band to get events from can be passed as an argument: +Additionally, the energy band in KeV to get events from can be passed as an argument. The default value is [3,20]. -`obs = nuwavsource.Observation(path_to_evt_file,E_borders=[E_min,E_max])` - -The default value used in the code is [3,20] +```python +obs = nuwavsource.Observation(path_to_evt_file,E_borders=[E_min,E_max]) +```