1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
.. _installing:
************
Installation
************
`xsar` relies on gdal_ and other shared libs, that are not provided by pip.
So insallation in a conda_ environement is recommended.
conda install
#############
1) Install mamba
For a faster installation and less conflicts between packages, it is better to install
xsar with mamba
.. code-block::
conda create -n xsar
conda activate xsar
conda install -c conda-forge mamba
2) Install xsar (this won't include the readers)
.. code-block::
mamba install -c conda-forge xsar
3) Add optional dependencies (readers)
- Add use of Radarsat2 :
.. code-block::
mamba install -c conda-forge xradarsat2
- Add use of Sentinel-1
.. code-block::
mamba install -c conda-forge xarray-safe-s1
- Add use of RCM
.. code-block::
pip install xarray-safe-rcm
pip install
###########
1) Install xsar (this won't include the readers)
.. code-block::
conda create -n xsar
conda activate xsar
pip install xsar
2) install xsar with optional dependencies (to use Sentinel-1, Radarsat2, RCM...)
- Install xsar including Sentinel-1 :
.. code-block::
pip install xsar[S1]
- Install xsar including Radarsat2 :
.. code-block::
pip install xsar[RS2]
- Install xsar including RCM :
.. code-block::
pip install git+https://github.com/umr-lops/xarray-safe-rcm.git
pip install xsar
- Install xsar including multiple readers/dependencies (here Radarsat2 and RCM):
.. code-block::
pip install xsar[RS2,RCM]
- Install xsar including Radarsat2, Sentinel-1 and RCM:
.. code-block::
pip install xsar[RS2,S1, RCM]
recommended packages
....................
Default installation is minimal, and should be used in non-interactive environment.
Xsar can be used in jupyter, with holoviews and geoviews. To install aditional dependancies, run:
.. code-block::
pip install -r https://raw.githubusercontent.com/umr-lops/xsar/develop/requirements.txt
pip install git+https://github.com/umr-lops/xsarsea.git
Update xsar to the latest version
#################################
xsar conda package can be quite old:
.. image:: https://anaconda.org/conda-forge/xsar/badges/latest_release_relative_date.svg
To be up to date with the developpement team, it's recommended to update the installation using pip:
.. code-block::
pip install git+https://github.com/umr-lops/xsar.git
Developement installation
..........................
.. code-block::
git clone https://github.com/umr-lops/xsar
cd xsar
# this is needed to register git filters
git config --local include.path ../.gitconfig
pip install -e .
pip install -r requirements.txt
.. _conda: https://docs.anaconda.com/anaconda/install/
.. _gdal: https://gdal.org/
.. _xsarsea: https://cyclobs.ifremer.fr/static/sarwing_datarmor/xsarsea
|
