Merge pull request #48 from AUAS-Pulsar/pipeline-docs

add overview chapter to pipeline docs

Author: maxvhas

docs/pipeline.md

@@ -53,3 +53,24 @@ pipeline.Pipeline(<filterbank_file>)
 
 The `measure_methods` is ran for each of the above methods, and calculates the time it takes to run each of the different methods. For each method it will create a key using the name of the method, and save the time it took to run the method as a value.
 At the end, it will returns a dictionary with all the keys and values.
+
+## 7.6 Overview of pipeline
+
+Apart from the different modules described in the previous paragraphs, additional modules are required for this library to make detecting pulsar signals possible.
+However, these additional modules have not been developed yet, and are required to be developed in the future. In this paragraph the additional
+modules are listed and described.
+
+Modules that are missing in the pipeline are highlighted using a `*`.
+
+```
+1. Read Filterbank as stream
+2. Reduce RFI using clipping
+3. Dedisperse radio signal
+4. Transform dedispersed signal to TimeSeries
+5. Run fast Fourier transformation on TimeSeries
+6. * Identify and save birdies in file
+7. * Perform Harmonic Summing
+8. * Search and identify single and periodic signals
+9. * Phase-fold remaining signals
+10.* Do Transient searches
+```