Skip to content

Commit a17339d

Browse files
committed
seperate docs for getting started and filterbank tutorial
1 parent bc7e67f commit a17339d

File tree

2 files changed

+23
-34
lines changed

2 files changed

+23
-34
lines changed

README.md

Lines changed: 6 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,13 @@
77

88
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++.
99

10-
## Installation
11-
12-
### Requirements
10+
## Requirements
1311

1412
* numpy
1513
* python 3.6
1614

17-
18-
# Getting started
19-
20-
## Example filterbank files
21-
### Use one of the following filterbank files as an example:
22-
* <a href="https://git.dev.ti-more.net/uploads/-/system/personal_snippet/2/bc063035797e978034adfb6f2da75e70/pspm8.fil">8 bit</a>
23-
* <a href="https://git.dev.ti-more.net/uploads/-/system/personal_snippet/2/bc063035797e978034adfb6f2da75e70/pspm16.fil">16 bit</a>
24-
* <a href="https://git.dev.ti-more.net/uploads/-/system/personal_snippet/2/bc063035797e978034adfb6f2da75e70/pspm32.fil">32 bit</a>
25-
26-
## Import
27-
> ```from filterbank.filterbank import *```
28-
29-
# Tutorial
30-
31-
### Create a filterbank object
32-
> ``` filterbank = Filterbank(<PATH TO FILTERBANK FILE>) ```
33-
34-
### Read the header from filterbank data
35-
> ``` filterbank.header ```
36-
37-
### Read filterbank file to 3d numpy array
38-
> ``` filterbank.read_filterbank ```
39-
40-
### Calculate the frequency range
41-
> ``` filterbank.setup_freqs ```
42-
43-
### Calculate the time range
44-
> ``` filterbank.setup_freqs ```
15+
# Table of contents
16+
1. [Getting started](docs/gettingstarted.md)
17+
1. [Example files](docs/gettinstarted.md#11-example-files)
18+
2. [Import](docs/gettingstarted.md#12-import)
19+
2. [Filterbank tutorial](docs/filterbank.md)

docs/filterbank.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
1-
# Filterbank (INOP)
1+
# Filterbank Tutorial
22

3-
This document will give you info regarding the filterbank data.
3+
### Create a filterbank object
4+
> ``` filterbank = Filterbank(<PATH TO FILTERBANK FILE>) ```
45
5-
//ToDo Add info..
6+
### Read the header from filterbank data
7+
> ``` filterbank.header ```
8+
9+
### Read filterbank file to 3d numpy array
10+
> ``` filterbank.read_filterbank ```
11+
12+
### Calculate the frequency range
13+
> ``` filterbank.setup_freqs ```
14+
15+
### Calculate the time range
16+
> ``` filterbank.setup_time ```
17+
18+
### Calculate the time range
19+
> ``` filterbank.setup_time ```

0 commit comments

Comments
 (0)