Skip to content

Commit 8648bb4

Browse files
committed
Test the README and small updates
1 parent a20fb31 commit 8648bb4

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

README.md

+34-10
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Overall the software is in the **alpha** phase and the usual caveats apply.
2525
- reads uncompressed and compressed SAFE data products on the local computer or
2626
on a network via [*fsspec*](https://filesystem-spec.readthedocs.io) - *dependes on rasterio>=1.3a3*
2727
- supports larger-than-memory and distributed data access via [*dask*](https://dask.org) and
28+
[*rioxarray*](https://corteva.github.io/rioxarray) /
2829
[*rasterio*](https://rasterio.readthedocs.io) / [*GDAL*](https://gdal.org)
2930

3031
## Install
@@ -421,18 +422,41 @@ Attributes: ...
421422
```
422423

423424
*fsspec* is very powerful and supports caching and chaining, for example you can open a
424-
zip file off a private Google Storage bucket and cache the file locally with:
425+
zip file off a GitHub repo and cache the file locally with:
425426

426427
```python-repl
427-
xr.open_dataset(
428-
"zip://*/manifest.zip::simplecache::gcs://bucket/afile.zip",
429-
engine="sentinel-1",
430-
storage_options={
431-
"simplecache": {"cache_storage": "/stored/zip/files"},
432-
"gcs": {'project': 'my-project'},
433-
},
434-
)
435-
...
428+
>>> xr.open_dataset(
429+
... f"zip://*/manifest.safe::simplecache::github://bopen:xarray-sentinel@/{slc_iw_zip_path}",
430+
... engine="sentinel-1",
431+
... group="IW1/VH",
432+
... storage_options={
433+
... "simplecache": {"cache_storage": "/tmp/zipfiles/"},
434+
... },
435+
... )
436+
<xarray.Dataset>
437+
Dimensions: (pixel: 21632, line: 13509)
438+
Coordinates:
439+
* pixel (pixel) int64 0 1 2 3 4 ... 21627 21628 21629 21630 21631
440+
* line (line) int64 0 1 2 3 4 5 ... 13504 13505 13506 13507 13508
441+
azimuth_time (line) datetime64[ns] ...
442+
slant_range_time (pixel) float64 ...
443+
Data variables:
444+
measurement (line, pixel) complex64 ...
445+
Attributes: ...
446+
sar:center_frequency: 5.40500045433435
447+
sar:pixel_spacing_azimuth: 13.94053
448+
sar:pixel_spacing_range: 2.329562
449+
azimuth_time_interval: 0.002055556299999998
450+
slant_range_time_interval: 1.554116558005821e-08
451+
azimuth_steering_rate: 1.590368784
452+
... ...
453+
sar:product_type: SLC
454+
xs:instrument_mode_swaths: ['IW1', 'IW2', 'IW3']
455+
group: /IW1/VH
456+
subgroups: ['orbit', 'attitude', 'azimuth_fm_rate', 'dc_...
457+
Conventions: CF-1.8
458+
history: created by xarray_sentinel-...
459+
436460
```
437461

438462
## Design decisions

0 commit comments

Comments
 (0)