From bddde49cd6ae85a67c4775f47a86f89dd625d140 Mon Sep 17 00:00:00 2001 From: Andrey Mukhin Date: Fri, 9 Sep 2022 17:31:21 +0300 Subject: [PATCH] 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]) +```