nustar/nuwavdet
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Андрей Мухин 2022-09-09 17:31:21 +03:00 committed by GitHub
parent c447a3d357
commit bddde49cd6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -24,20 +24,26 @@ This package is to be used with Python 3.x.x
To install tha package write To install tha package write
`pip install nuwavsource` ```bash
pip install nuwavsource
```
## Usage ## Usage
To use the package in your project, import it in by writing 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: 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])` ```python
obs = nuwavsource.Observation(path_to_evt_file,E_borders=[E_min,E_max])
The default value used in the code is [3,20] ```