[ONGOING] Documentation of the Project
Opened this issue · 0 comments
schote commented
This is an ongoing task.
The documentation, which is deployed to GitHub pages contains the following sections:
- Quick start guide: How to install
- User guide: Explain concepts
- Examples
- API reference: Code documentation
The user guide should explain the following concepts:
- Acquisition control
- Interfaces
- Sequence calculation
- Spectrum device
- Transmit device
- Receive device
- Sequence constructors
- DDC
- SNR
Examples to be implemented:
- Execute a simple sequence (spectrum)
- Image acquisition
- Plot a sequence
- SNR calculation
- Compare DDC functions