Update documentation for public release

[stephengreen]

This revamps the documentation to bring it up to date, addressing #154.

Sections

The following sections are clearly in need of updates:

• [x] Index
• [x] Installation
• [x] Overview
• [x] Quickstart tutorial (see also #146 ) @nihargupte-ph
• [x] Detector noise @jonaswildberger
• [x] Network architecture @max-dax

Please feel free to contribute where appropriate.

[stephengreen]

Thanks for all your help, everyone!

Examples

I think it would be useful to structure the example directories as

examples/
    binary_black_hole_simple/
    binary_black_hole_O1_gnpe_synthetic_phase/
    binary_black_hole_O1_no_gnpe/

(or some variation on this). Each of these would then contain all config files needed to generate data, train the network(s), and perform inference. That makes it easy for the user to just look at one directory to start.

The tutorial should then go step by step through the binary_black_hole_simple example. This should be something that can run on a laptop in < 1 hour, probably with a fixed PSD (e.g., GW150914) and no GNPE. The results might be no good, but the point is that people can run it in a reasonable amount of time and get results.

dingo_analyze_event

How much is this still being used? Probably for the documentation we should favor discussion of dingo_pipe, so some references to dingo_analyze_event should be changed.

[stephengreen]

I have made a new "Examples" section in the docs. This could be used to provide commentary for all of the examples we include in the repo.