Skip to content

Commit 11e6cf6

Browse files
committed
docs update
1 parent 20573e3 commit 11e6cf6

4 files changed

Lines changed: 25 additions & 99 deletions

File tree

docs/dev.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# xcube-smos Internals
2+
3+
### Code installation
4+
5+
#### For users
6+
7+
xcube-smos end users can install xcube-smos directly from its git repository
8+
into an xcube environment created with
9+
[mamba](https://mamba.readthedocs.io/en/latest/installation.html)
10+
(recommended) or
11+
[conda](https://docs.conda.io/en/latest/miniconda.html).
12+
13+
```bash
14+
mamba create -n xcube -c conda-forge xcube
15+
mamba activate xcube
16+
git clone https://github.com/dcs4cop/xcube-smos.git
17+
cd xcube-smos
18+
pip install --verbose --no-deps --editable .
19+
```
20+

docs/guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ different representations of SMOS data addressing different use cases:
7171
* `"mldataset:zarr:smos"` - represent data as a multi-resolution datacube
7272
including all observations in the given time range including 5 spatial
7373
resolution levels;
74-
* `"dsiter:zarr:smos"` - represent data as an iterator providing datasets
74+
* `"smosdsiter:zarr:smos"` - represent data as an iterator providing datasets
7575
for all the observations in the given time range at a fixed spatial
7676
resolution.
7777

docs/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ from xcube.core.store import new_data_store
2323
store = new_data_store("smos", **credentials)
2424
datacube = store.open_data(
2525
"SMOS-L2C-SM",
26-
time_range=("2022-01-01", "2022-01-06")
26+
time_range=("2022-01-01", "2022-01-06"),
27+
bbox=(0, 40, 20, 60)
2728
)
2829
```
2930

@@ -49,6 +50,7 @@ resolution by a factor of two.
4950

5051

5152
`xcube-smos` does not perform any aggregation in the time dimension. Data is
52-
provided as-is, that is, 29 SMOS Level-2 data products are included per day.
53+
provided as-is, that is, up to 29 SMOS Level-2 data products are included
54+
per day.
5355

5456

docs/internals.md

Lines changed: 0 additions & 96 deletions
This file was deleted.

0 commit comments

Comments
 (0)