README.md 2.92 KB
Newer Older
1
2
# Water color TriOS package

3
Package to process TriOS-like radiometer data for various acquisition protocols:
Harmel Tristan's avatar
Harmel Tristan committed
4
5

- **Above-Water Radiometry** (_awr_): R<sub>rs</sub> (sr<sup>-1</sup>)
Harmel Tristan's avatar
Harmel Tristan committed
6

Harmel Tristan's avatar
Harmel Tristan committed
7
8
<p align="center">
    <img src="images/above_water_system.png" width="400">
Harmel Tristan's avatar
Harmel Tristan committed
9
10
</p>

Harmel Tristan's avatar
Harmel Tristan committed
11
12
13
14
15
16
17
- **In-Water Radiometry** (_iwr_): R<sub>rs</sub> (sr<sup>-1</sup>), K<sub>d</sub> (m<sup>-1</sup>), K<sub>Lu</sub> (m<sup>-1</sup>)

<p align="center">
    <img src="images/in_water_system.png" width="400">
</p>

- **Surface-Water Radiometry** (_swr_): R<sub>rs</sub> (sr<sup>-1</sup>)
Harmel Tristan's avatar
Harmel Tristan committed
18

Harmel Tristan's avatar
Harmel Tristan committed
19
20
21
<p align="center">
    <img src="images/surface_water_radiometry.png" width="400">
</p>
Harmel Tristan's avatar
Harmel Tristan committed
22
23


24
25

This package also contains tools for interactive visualization of the radiometric data: 
26
27
28

![animated1](images/visu_trios_data.gif)

Harmel Tristan's avatar
Harmel Tristan committed
29

30
31
32
33
34
35
36
37
38
## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

What things you need to install the software and how to install them

```
Harmel Tristan's avatar
Harmel Tristan committed
39
python3 -m pip install --user --upgrade setuptools
40
41
42
43
```

### Installing

Harmel Tristan's avatar
Harmel Tristan committed
44
First, clone [the repository](https://gitlab.irstea.fr/telquel-obs2co/insitu/trios#) and execute the following command in the
Harmel Tristan's avatar
Harmel Tristan committed
45
local copy:
46

Harmel Tristan's avatar
Harmel Tristan committed
47
48
49
```
python3 setup.py install 
```
50

Harmel Tristan's avatar
Harmel Tristan committed
51
52
This will install the package into the system's Python path.
If you have not the administrator rights, you can install the package as follows:
Harmel Tristan's avatar
Harmel Tristan committed
53

Harmel Tristan's avatar
Harmel Tristan committed
54
55
56
```
python3 setup.py install --user
```
Harmel Tristan's avatar
Harmel Tristan committed
57

Harmel Tristan's avatar
Harmel Tristan committed
58
If another destination directory is preferred, it can be set by
Harmel Tristan's avatar
Harmel Tristan committed
59

Harmel Tristan's avatar
Harmel Tristan committed
60
61
62
```
python3 setup.py install --prefix=<where-to-install>
```
Harmel Tristan's avatar
Harmel Tristan committed
63
64
65

This installation is supposed to download
and compile all the associated packages as well as prepare the executables `trios_processing` and `trios_visual`.
66

Harmel Tristan's avatar
Harmel Tristan committed
67
68
69
70
71
72
73
74
75
If the installation is successful, you should have:
```
$ trios_processing
Usage:
  trios_processing <input_dir> <IDpr> <measurement_type> --lat <lat> --lon <lon>    [--altitude=alt] [--ofile <ofile>] [--odir <odir>] [--plot] [--figdir <figdir>]    [--name <name>] [--method <method>] [--no_clobber]
  trios_processing -h | --help
  trios_processing -v | --version
```

76
77
## Running the tests

Harmel Tristan's avatar
Harmel Tristan committed
78
79
80
81
82
```
trios_processing ./test/data/ 150 awr --lat 42.30351823 --lon 9.462897398 --odir ./test/results --no_clobber
trios_processing ./test/data/ 150 awr --lat 42.30351823 --lon 9.462897398 --odir ./test/results --method M99 --name _M99 --plot --figdir ./test/fig
trios_processing ./test/data/ 150 awr --lat 42.30351823 --lon 9.462897398 --odir ./test/results --method osoaa --name _osoaa --plot
```
83

84
85
86
87
88
89
90
91
92
93
94
95
96

## Authors

* **Tristan Harmel** - *Initial work* -

See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

Harmel Tristan's avatar
Harmel Tristan committed
97
98
This work has been partially supported by the _Programme National de Télédétection Spatiale_ (PNTS,
http://www.insu.cnrs.fr/pnts ), grant n°PNTS-2019-13