hpx-cli 0.1.0__py3-none-win_amd64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Binary file
@@ -0,0 +1,404 @@
1
+ Metadata-Version: 2.4
2
+ Name: hpx-cli
3
+ Version: 0.1.0
4
+ License-File: LICENSE-APACHE
5
+ License-File: LICENSE-MIT
6
+ License-File: COPYING
7
+ Summary: Command-line tool to play with HEALPix
8
+ Keywords: healpix,skymap
9
+ Home-Page: https://github.com/cds-astro/cds-healpix-rust/tree/main/crates/cli
10
+ Author: F.-X. Pineau <francois-xavier.pineau@astro.unistra.fr>
11
+ Author-email: F.-X. Pineau <francois-xavier.pineau@astro.unistra.fr>
12
+ License: MIT OR Apache-2.0
13
+ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
14
+ Project-URL: repository, https://github.com/cds-astro/cds-healpix-rust/tree/master/crates/cli
15
+
16
+ # `hpx-cli`
17
+
18
+ Perform HEALPix related operations from the command line.
19
+
20
+ ## About
21
+
22
+ This **C**ommand **Line** **I**nterface (CLI) is made from the
23
+ [CDS HEALPix Rust library](https://github.com/cds-astro/cds-healpix-rust).
24
+ It allows to perform HEALPix related operations like:
25
+ adding a column of HEALPix indices computed from positions to a CSV file;
26
+ indexing and querying a CVS file by HEALpix indices;
27
+ build density maps; get the vertices of given HEALpix cells;
28
+ and more.
29
+
30
+ For a complementaty tool manipulating MOCs,
31
+ see [moc-cli](https://github.com/cds-astro/cds-moc-rust/tree/main/crates/cli).
32
+
33
+ ## Install
34
+
35
+ ### From pypi for Python users
36
+
37
+ hpx-cli is available in [pypi](https://pypi.org/project/hpx-cli),
38
+ you can thus install the `hpx` executable using `pip`:
39
+
40
+ ```bash
41
+ pip install -U hpx-cli
42
+ moc --help
43
+ ```
44
+
45
+ ### Pre-compile binaries for MacOS, Linux and Windows, and .deb packages
46
+
47
+ See the [github release page](https://github.com/cds-astro/cds-moc-rust/releases),
48
+ simply download, unpack and exec the binary file.
49
+
50
+ ### From source code (Rust compiler needed)
51
+
52
+ [Install rust](https://www.rust-lang.org/tools/install)
53
+ (and check that `~/.cargo/bin/` is in your path),
54
+ or update the Rust compiler with:
55
+
56
+ ```bash
57
+ rustup update
58
+ ```
59
+
60
+ Clone the [cdshealpix rust lib](https://github.com/cds-astro/cds-healpix-rust) project:
61
+
62
+ ```bash
63
+ git clone https://github.com/cds-astro/cds-healpix-rust
64
+ ```
65
+
66
+ Install from using `cargo`:
67
+
68
+ ```bash
69
+ cargo install --path crates/cli
70
+ ```
71
+
72
+ (due to a heavy use of [monomorphization](https://en.wikipedia.org/wiki/Monomorphization),
73
+ the compilation time may be long).
74
+
75
+ ## Command line help (excerpt)
76
+
77
+ ```bash
78
+ > hpx --help
79
+ Command-line tool to play with HEALPix
80
+
81
+ Usage: hpx <COMMAND>
82
+
83
+ Commands:
84
+ proj Computes the projected coordinates (x, y) ∊ ([0..8[, [-2..2]) of input equatorial coordinates
85
+ unproj Computes the equatorial coordinates of Healpix projected coordinates (x, y) ∊ ([0..8[, [-2..2])
86
+ nested Operations in the HEALPix NESTED scheme
87
+ sort Sorts a CSV file by order 29 HEALPix NESTED indices, uses external sort to support huge files
88
+ hcidx Create an index on an HEALPix NESTED sorted CSV file to then quickly retrieve rows in a given HEALPix cell
89
+ qhcidx Query an HEALPix sorted and indexed CSV file (see the 'hcidx' command)
90
+ map Create and manipulate HEALPix count and density maps
91
+ mom Create and manipulate HEALPix count and density maps
92
+ cov Compute the list of NESTED Healpix cells in a given sky region (see also moc-cli)
93
+ help Print this message or the help of the given subcommand(s)
94
+
95
+ Options:
96
+ -h, --help Print help
97
+ -V, --version Print version
98
+ ```
99
+
100
+ ```bash
101
+ > hpx nested --help
102
+ Operations in the HEALPix NESTED scheme
103
+
104
+ Usage: hpx nested <COMMAND>
105
+
106
+ Commands:
107
+ table Prints the table of Healpix layers properties (depth, nside, ncells, ...)
108
+ bestdepth For a cone of given radius, returns the largest depth at which the cone covers max 9 cells
109
+ hash Get the Healpix hash value (aka ipix or cell number) of given equatorial position(s)
110
+ bilinear Get the bilinear interpolation parameters, 4x(hash, weight), of given equatorial position(s)
111
+ center Get the longitude and latitude (in degrees) of the center of the cell of given hash value
112
+ vertices Get the longitude and latitude (in degrees) of the 4 vertices (S, W, N, E) of the cell of given hash value
113
+ neighbours Get the hash value (aka ipix or cell number) of the neighbours of the cell of given hash value (S, SE, E, SW, NE, W, NW, N)
114
+ touniq Transform regular hash values (aka ipix or cell numbers) into the UNIQ representation
115
+ toring Transform regular hash values (aka ipix or cell numbers) from the NESTED to the RING scheme
116
+ help Print this message or the help of the given subcommand(s)
117
+
118
+ Options:
119
+ -h, --help Print help
120
+
121
+ ```
122
+
123
+ ```bash
124
+ > hpx cov --help
125
+ Compute the list of NESTED Healpix cells in a given sky region (see also moc-cli)
126
+
127
+ Usage: hpx cov [OPTIONS] <DEPTH> <COMMAND>
128
+
129
+ Commands:
130
+ cone Cone coverage
131
+ ellipse Elliptical cone coverage
132
+ ring Ring coverage
133
+ zone Zone coverage
134
+ box Box coverage
135
+ polygon Polygon coverage
136
+ stcs STC-S region coverage
137
+ stcsfile STC-S region provided in a file coverage
138
+ convert From reading a regular FITS encoded BMOC
139
+ help Print this message or the help of the given subcommand(s)
140
+
141
+ Arguments:
142
+ <DEPTH>
143
+ Maximum depth (aka order) of the Healpix cells in the coverage
144
+
145
+ Options:
146
+ -t, --out-type <OUTPUT_TYPE>
147
+ Output type
148
+
149
+ [default: csv]
150
+
151
+ Possible values:
152
+ - csv: CSV serialization
153
+ - fits: FITS serialization
154
+ - bintable: FITS BINTABLE serialization
155
+
156
+ -o, --output-file <FILE>
157
+ Write in the given output file instead of stdout (mandatory for FITS)
158
+
159
+ -h, --help
160
+ Print help (see a summary with '-h')
161
+
162
+ ```
163
+
164
+ Tip: you can use `--help` inside sub-commands, sub-sub-commands, ... to get contextual help!
165
+
166
+ ## Examples
167
+
168
+ You may find a quite extensive set of examples it
169
+ the test script [test.bash](test/test.bash).
170
+
171
+ But here a few additional examples.
172
+
173
+ ### Compute both the density map and the density MOM of 1.4 billion sources
174
+
175
+ The file `gaia_edr3_dist.csv` is a 165 GB file containing 1\,467\,744\,819 rows and 10 columns:
176
+
177
+ ```bash
178
+ > head -10 gaia_edr3_dist.csv
179
+ source_id,RA_ICRS,DE_ICRS,r_med_geo,r_lo_geo,r_hi_geo,r_med_photogeo,r_lo_photogeo,r_hi_photogeo,flag
180
+ 1000000057322000000,104.87975539563,55.95486459306,784.559143,476.918579,1348.18896,2343.54736,1892.65027,2683.65625,20033
181
+ 1000000121746472704,104.85627575018,55.96825004364,1875.9657,1396.88684,2913.11401,1552.66638,1330.32129,1744.04968,10033
182
+ 1000000156106220032,104.86295428908,55.97882280840,2708.93115,1986.14282,4164.81152,1827.14001,1626.5304,1988.9436,10033
183
+ 1000000156106221440,104.85273193584,55.98099099003,1336.84521,1198.19202,1502.92432,1203.64136,1117.92993,1306.02368,10033
184
+ ...
185
+ ```
186
+
187
+ We want to build and view the density map of the file at an HEALPix depth = 11.
188
+ First build the density map:
189
+
190
+ ```bash
191
+ > time hpx map dens 11 gaia_edr3_dist.dens.fits csv -d , -l 2 -b 3 --header --chunk-size 100000000 --parallel 32 gaia_edr3_dist.csv
192
+
193
+ real 15m27,858s
194
+ user 27m20,545s
195
+ sys 34m42,810s
196
+ ```
197
+
198
+ Or, a better option (faster while single-threaded):
199
+
200
+ ```bash
201
+ > time cut -f , -d 2,3 gaia_edr3_dist.csv | tail -n +2 \
202
+ | hpx map dens 11 gaia_edr3_dist.dens.fits list -d ,
203
+
204
+ real 8m25,812s
205
+ user 11m7,242s
206
+ sys 3m40,669s
207
+ ```
208
+
209
+ The outut file size is 385 MB (quite large!): 50\,331\,648 cells containing a double precision
210
+ float do lead to $\frac{50331648 \times 8}{1024^2} = 384\,\mathrm{MB}$.
211
+ We can transform it into a 400x800 pixels PNG file to visualize it:
212
+
213
+ ```bash
214
+ > time hpx map view --silent gaia_edr3_dist.dens.fits gaia_edr3_dist.dens.png allsky 400
215
+
216
+ real 0m20,361s
217
+ user 0m19,246s
218
+ sys 0m0,492s
219
+ ```
220
+
221
+ Here the result (a default ICRS to GALACTIC transformation is applied):
222
+ ![](img/gaia_edr3_dist.dens.png)
223
+
224
+ Both to reduce its size, and to remove the white noise, we can make a `Chi2 MOM`, i.e.
225
+ a multi-resolution map obtained by merging sibling cells having densities possibly coming from a same common density
226
+ according to a chi-square criterion (the conversion is quite fast, 1s):
227
+
228
+ ```bash
229
+ > time hpx map convert gaia_edr3_dist.dens.fits gaia_edr3_dist.dens.mom.fits dens2chi2mom
230
+
231
+ real 0m0,978s
232
+ user 0m0,661s
233
+ sys 0m0,317s
234
+ ```
235
+
236
+ The result file is now 13 MB large (a **x30 compression factor, while removing noise**!).
237
+ We can visualize this MOM content, also transforming it into a 400x800 pixels PNG file:
238
+
239
+ ```bash
240
+ time hpx mom view --silent gaia_edr3_dist.dens.mom.fits gaia_edr3_dist.dens.mom.png allsky 400
241
+
242
+ real 0m0,494s
243
+ user 0m0,478s
244
+ sys 0m0,013s
245
+ ```
246
+
247
+ And here the result (much faster to compute, only 0.5s):
248
+ ![](img/gaia_edr3_dist.dens.mom.png)
249
+
250
+ Now let's zoom and the LMC (position 080.8942 -69.7561 in ICRS and 280.4652 -32.8884 in galactic):
251
+
252
+ Both in the density map
253
+
254
+ ```bash
255
+ > time hpx map view --silent gaia_edr3_dist.dens.fits gaia_edr3_dist.dens.lmc.png custom -l 280.4652 -b -32.8884 sin 400 400 --x-bounds [-0.15..0.15] --y-bounds [-0.15..0.15]
256
+
257
+ real 0m7,507s
258
+ user 0m7,277s
259
+ sys 0m0,229s
260
+ ```
261
+
262
+ and in the density MOM:
263
+
264
+ ```bash
265
+ > time hpx mom view --silent gaia_edr3_dist.dens.mom.fits gaia_edr3_dist.dens.mom.lmc.png custom -l 280.4652 -b -32.8884 sin 400 400 --x-bounds [-0.15..0.15] --y-bounds [-0.15..0.15]
266
+
267
+ real 0m0,237s
268
+ user 0m0,227s
269
+ sys 0m0,010s
270
+ ```
271
+
272
+ ![](img/gaia_edr3_dist.dens.lmc.png)
273
+ ![](img/gaia_edr3_dist.dens.mom.lmc.png)
274
+
275
+ #### Remark:
276
+
277
+ For mote details on the available projections in the `view` command,
278
+ see [mapproj](https://github.com/cds-astro/cds-mapproj-rust).
279
+
280
+ ### Indexation of a large CSV file
281
+
282
+ Like in the previous example, we are working with the 165 GB large file `gaia_edr3_dist.csv`
283
+ (1\,467\,744\,819 rows, 10 columns), which is larger that the available RAM on the test machine.
284
+
285
+ We can first sort this file according the order 29 HEALPix indices:
286
+
287
+ ```bash
288
+ time hpx sort --header -d , -o gaia_edr3_dist.sorted.csv -l 2 -b 3 gaia_edr3_dist.csv
289
+
290
+ real 89m5,997s
291
+ user 184m9.269s
292
+ sys 23m21,342s
293
+ ```
294
+
295
+ Then, we index the sorted file at an HEALPix level equals to 9 (to limit the size of the index file):
296
+
297
+ ```bash
298
+ time hpx hcidx --header -d , --depth 9 -o gaia_edr3_dist.sorted.hci.fits -l 2 -b 3 gaia_edr3_dist.sorted.csv
299
+
300
+ real 6m39,257s
301
+ user 4m51,979s
302
+ sys 1m30,032s
303
+ ```
304
+
305
+ the size of the resulting index file `gaia_edr3_dist.sorted.hci.fits` is 25 MB.
306
+ At order 9, HEALPix cells size is about 7 arcmin by 7 arcmin.
307
+
308
+ Now, let compute the BMOC of a cone of 0.2 degrees around the LMC:
309
+
310
+ ```bash
311
+ time hpx cov 9 --out-type fits --output-file cone.bmoc.fits cone 080.8942 -69.7561 0.2
312
+
313
+ real 0m0,006s
314
+ user 0m0,001s
315
+ sys 0m0,005s
316
+ ```
317
+
318
+ It is a 'small' BMOC containing only a few cells. We can visualize (and compute the center of the cells):
319
+
320
+ ```bash
321
+ time hpx cov 9 convert cone.bmoc.fits | tail -n +2 | hpx nested center 9 csv -d , -f 2 --header --paste --paste-header "center_lon,center_lat"
322
+ order,ipix,is_fully_covered_flag,center_lon,center_lat
323
+ 9,2118189,0,080.7110091743119,-69.9794867201383
324
+ 9,2118191,0,080.3424657534247,-69.8866968891410
325
+ 9,2118194,0,081.1238532110092,-69.9794867201383
326
+ 9,2118195,0,081.1643835616438,-69.8866968891410
327
+ 9,2118196,0,081.5753424657534,-69.8866968891410
328
+ 9,2118197,0,081.6136363636364,-69.7938937311056
329
+ 9,2118198,0,081.2045454545455,-69.7938937311056
330
+ 9,2118199,0,081.2443438914027,-69.7010771793946
331
+ 9,2118200,0,080.7534246575343,-69.8866968891410
332
+ 9,2118201,1,080.7954545454545,-69.7938937311056
333
+ 9,2118202,0,080.3863636363636,-69.7938937311056
334
+ 9,2118203,0,080.4298642533936,-69.7010771793946
335
+ 9,2118204,1,080.8371040723982,-69.7010771793946
336
+ 9,2118205,0,080.8783783783784,-69.6082471672874
337
+ 9,2118206,0,080.4729729729730,-69.6082471672874
338
+ 9,2118207,0,080.5156950672646,-69.5154036279795
339
+ 9,2118240,0,081.6515837104072,-69.7010771793946
340
+ 9,2118242,0,081.2837837837838,-69.6082471672874
341
+ 9,2118248,0,080.9192825112108,-69.5154036279795
342
+
343
+ real 0m0,008s
344
+ user 0m0,005s
345
+ sys 0m0,013s
346
+ ```
347
+
348
+ And now, let's retrieve and count the number of sources the 165 GB files contains in those cells:
349
+
350
+ ```bash
351
+ time hpx qhcidx gaia_edr3_dist.sorted.hci.fits bmoc cone.bmoc.fits | wc -l
352
+ 240021
353
+
354
+ real 0m0,207s (0m0.034s with a hot cache)
355
+ user 0m0,000s
356
+ sys 0m0,076s
357
+ ```
358
+
359
+ Thus, **240\,021 rows (including the header line), out of 1.4 billion, have been retrieved in 0.2s** with a cold cache (
360
+ 0.034s
361
+ with a hot cache). We let the user take care of applying a post-filter fitting the original cone.
362
+
363
+ #### Remarks:
364
+
365
+ * In [QAT2S](https://pretalx.com/adass2023/talk/3MTUUL/), we do have the code to post-filter the result to keep only
366
+ sources in the original area (a cone here). We so
367
+ far do not plan to add this in hpx-cli, but to add CSV files indexation in QAT2S.
368
+ * For a static binary-search index on a CSV column, see the possible usage of
369
+ the [cds-bstree-file-readonly-rust](https://github.com/cds-astro/cds-bstree-file-readonly-rust) repository.
370
+
371
+ ## To-do list
372
+
373
+ * [ ] Add more methods to merge Skymaps (diff, mult, ...)
374
+ * [ ] Add more methods to merge MOMs (add, diff, mult, ...)
375
+ * [ ] Add `path_along_cell_edge` method?
376
+ * [ ] Create an implicit density map covering only the cells in a BMOC?
377
+ * [ ] ...
378
+
379
+ ## Disclaimer
380
+
381
+ Such a tool is developed by a single person, in charge of other duties, with a limited amount of time.
382
+ It is probably not as bulletproof as I would like: in case of bug, please open an issue.
383
+ Also, the CLI serve mainly two purposes: my own usage, and be a demonstrator to quickly test functionalities.
384
+ It means that no much thought has been given to make it user friendly (it could change if people show an interest, help
385
+ welcome to improve this).
386
+
387
+ ## License
388
+
389
+ Like most projects in Rust, this project is licensed under either of
390
+
391
+ * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
392
+ http://www.apache.org/licenses/LICENSE-2.0)
393
+ * MIT license ([LICENSE-MIT](LICENSE-MIT) or
394
+ http://opensource.org/licenses/MIT)
395
+
396
+ at your option.
397
+
398
+ ## Contribution
399
+
400
+ Unless you explicitly state otherwise, any contribution intentionally submitted
401
+ for inclusion in this project by you, as defined in the Apache-2.0 license,
402
+ shall be dual licensed as above, without any additional terms or conditions.
403
+
404
+
@@ -0,0 +1,7 @@
1
+ hpx_cli-0.1.0.dist-info/METADATA,sha256=v70_MGWSmFStTd5Z3CseRBgxSPi4eZuu6OeuGKXSLOA,14213
2
+ hpx_cli-0.1.0.dist-info/WHEEL,sha256=LLQFiH3PDiV0Fx2rdtwgTAjjdTZOsQg2uytkqCh5Fbg,93
3
+ hpx_cli-0.1.0.dist-info/licenses/LICENSE-APACHE,sha256=9BWmr9Bql2m7fjTuI2vfjhyIvR704hBdD190AbjPT8w,11054
4
+ hpx_cli-0.1.0.dist-info/licenses/LICENSE-MIT,sha256=qa7OhjFGbkj2HK6m6oe8FvAcPt9ZWGtYS3-_3MWSj8k,1102
5
+ hpx_cli-0.1.0.dist-info/licenses/COPYING,sha256=WZBTIe5sEG-ybS51Uja356Xkp6bF5cf8waHvZtTWgLo,126
6
+ hpx_cli-0.1.0.data/scripts/hpx.exe,sha256=OekArEcpE5iwHUeQNHXS_IZrIPp4k58BDdPv54zcOy8,4208128
7
+ hpx_cli-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: maturin (1.8.3)
3
+ Root-Is-Purelib: false
4
+ Tag: py3-none-win_amd64
@@ -0,0 +1,3 @@
1
+ This project is dual-licensed under the MIT and APACHE licenses.
2
+
3
+ You may use this code under the terms of either license.
@@ -0,0 +1,202 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2020 Universite de Strasbourg / CNRS
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
202
+
@@ -0,0 +1,26 @@
1
+ Copyright (c) 2020 Universite de Strasbourg / CNRS
2
+
3
+ Permission is hereby granted, free of charge, to any
4
+ person obtaining a copy of this software and associated
5
+ documentation files (the "Software"), to deal in the
6
+ Software without restriction, including without
7
+ limitation the rights to use, copy, modify, merge,
8
+ publish, distribute, sublicense, and/or sell copies of
9
+ the Software, and to permit persons to whom the Software
10
+ is furnished to do so, subject to the following
11
+ conditions:
12
+
13
+ The above copyright notice and this permission notice
14
+ shall be included in all copies or substantial portions
15
+ of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
18
+ ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
19
+ TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
20
+ PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
21
+ SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
24
+ IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25
+ DEALINGS IN THE SOFTWARE.
26
+