Merge pull request #10 from AUAS-Pulsar/readme

Readme

Author: TVH7

README.md

@@ -7,22 +7,17 @@
 
 Creating a free and open source framework that contains the generic algorithms and file handling for astronomical data sets. This framework will be modular. Similar to OpenCV, wherein specific modules can be added and disabled depended on the needs of a project. This framework will be implemented in Python and C++.
 
-## Installation
-
-### Requirements
+## Requirements
 
     * numpy
     * python 3.6
 
-
-## Documentation
-Will be added later. 
-
-## How to use this library
-
-### Read header data
-
-1. Specify the path to the filterbank file in the header.py file (line 124)
-2. Run the following command: `python header.py`
-
-# Asteria
+# Table of contents
+1. [Getting started](docs/gettingstarted.md)
+    1. [Example filterbank files](docs/gettingstarted.md#11-example-filterbank-files)
+    2. [Import](docs/gettingstarted.md#12-import)
+2. [Filterbank tutorial](docs/filterbank.md)
+    1. [Create filterbank object](docs/filterbank.md#21-create-filterbank-object)
+    2. [Read header from filterbank data](docs/filterbank.md#22-read-header-from-filterbank-data)
+    3. [Read filterbank file to 3d numpy array](docs/filterbank.md#23-read-filterbank-file-to-3d-numpy-array)
+    4. [Select a range of data from the filterbank file](docs/filterbank.md#24-select-a-range-of-data-from-the-filterbank-file)

docs/filterbank.md

@@ -1,5 +1,44 @@
-# Filterbank (INOP)
+# 2. Filterbank Tutorial
 
-This document will give you info regarding the filterbank data.
+### 2.1 Create a filterbank object
+```
+filterbank = Filterbank(<PATH TO FILTERBANK FILE>)
+```
+This is an example without parameters, see 2.3 for an example with the parameters.
+### 2.2 Read the header from filterbank data
+```
+filterbank.header
+```
 
-//ToDo Add info..  
+Header data contains the following:
+```
+* source_name 
+* DM
+* machine_id
+* telescope_id
+* data_type
+* fch1
+* foff
+* nchans
+* nbits
+* tstart
+* tsamp
+* nifs
+```
+freq_range = fch1 + nchans  
+time_range = tstart + (tsamp/24/60/60)
+
+freq_range is a tuple with a frequency start and a frequency stop  
+The same applies to time_range
+
+### 2.3 Read filterbank file to 3d numpy array
+The attributes time_range and freq_range can be passed as parameters to select a specific portion of the filterbank file, for example:  
+```
+filterbank = Filterbank(<PATH TO FILTERBANK FILE>, freq_range, time_range)
+```
+
+### 2.4 Select a range of data from the filterbank file
+The select_data method can be used to select a subset from the data read by the read_filterbank method.
+```
+filterbank.select_data(freq_range, time_range)
+```

docs/gettingstarted.md

@@ -0,0 +1,12 @@
+# 1. Getting started
+
+## 1.1 Example filterbank files
+### Use one of the following filterbank files as an example:
+* <a href="https://git.dev.ti-more.net/uploads/-/system/personal_snippet/2/bc063035797e978034adfb6f2da75e70/pspm8.fil">8 bit</a>
+* <a href="https://git.dev.ti-more.net/uploads/-/system/personal_snippet/2/3da35656df8f722441579847974a03cb/pspm16.fil">16 bit</a>
+* <a href="https://git.dev.ti-more.net/uploads/-/system/personal_snippet/2/e6015ec024ad1f53d4c2f39511620db1/pspm32.fil">32 bit</a>
+
+## 1.2 Import
+```
+from filterbank.filterbank import *
+```