IOTA2's documentation
IOTA2's documentation
In order to write a complete documentation of IOTA2, I propose to write it thanks to Sphinx. It allow us to provide a clear html/pdf documentation. The auto-doc feature is also interesting.
This documentation will be dedicated to users as well as developers.
The user part could be structured as the following :
- How to get IOTA2 ?
- 1.1 Licence
- 1.2 How to install IOTA2 ?
- 1.3 How to test installation
- IOTA2's inputs
- 2.1 Rasters
- 2.1.1 Optical
- 2.1.2 SAR
- 2.1.3 User Features
- 2.2 Vectors
- 2.2.1 Ground truth
- 2.2.2 Regions
- 2.3 IOTA2's parameters
- 2.3.1 Configuration file
- 2.3.2 Launching parameters
- 2.1 Rasters
- IOTA2's outputs
- ?
- IOTA2 step by step
- 4.1 IOTA's steps summary
- 4.2 IOTA's steps description
- 4.2.1 IOTA's init
- 4.2.2 ...
- Some Configuration's file example with data set
- 5.1 Simplest use-case, launch IOTA2 from scratch
- 5.2 some other use case
Firstly, parts 1. How to get IOTA2 ?
and 5.1 Simplest use-case, launch IOTA2 from scratch
could be written to rapidly help users to launch IOTA2.