Skip to content

Commit 635149a

Browse files
authored
Merge pull request #27 from dcs4cop/prepare_v020
Preparing for v0.2 release
2 parents 1edc0b4 + e685355 commit 635149a

5 files changed

Lines changed: 27 additions & 17 deletions

File tree

CHANGES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## Version 0.2.0 (in development)
1+
## Version 0.2.0
22

33
* Introduced open parameter `bbox`. [#20]
44
* Introduced open parameter `res_level`,
55
an integer value in the range 0 to 4. [#21]
66
* The SMOS auxiliary dataset _Discrete Global Grid_ (DGG)
7-
has been made package data in `xcube_smos/mldataset/smos-dgg.levels`.
7+
has been added as package data in `xcube_smos/mldataset/smos-dgg.levels`.
88
Hence, the store parameter `dgg_urlpath` has been removed. [#9]
99
* The NetCDF Kerchunk index can now also be a Zip archive.
1010
To use a Zip archive, pass an index path to the `nckcidx` CLI

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ named `smos` to xcube. The data store is used to
1414
access [ESA SMOS](https://earth.esa.int/eogateway/missions/smos) Level-2 data
1515
in form of analysis-ready geospatial datacubes with the dimensions
1616
`time`, `lat`, and `lon`. The datacubes are computed on-the-fly from the SMOS
17-
data archive `s3://EODATA/SMOS` hosted on [CreoDIAS](https://creodias.eu/).
17+
data archive `s3://EODATA/SMOS` hosted on [CREODIAS](https://creodias.eu/).
1818

1919
## Usage
2020

@@ -24,11 +24,17 @@ After installation, data access is as easy as follows:
2424
from xcube.core.store import new_data_store
2525

2626
store = new_data_store("smos", **credentials)
27-
28-
# Get a SMOS Soil Moisture datacube as xarray.Dataset
29-
# To access SMOS Ocean Salinity data use identifier "SMOS-L2C-OS"
30-
dataset = store.open_data(
27+
datacube = store.open_data(
3128
"SMOS-L2C-SM",
3229
time_range=("2022-01-01", "2022-01-06")
3330
)
3431
```
32+
33+
Above, a datacube of type
34+
[xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html)
35+
for SMOS **Soil Moisture** has been obtained.
36+
To access SMOS **Ocean Salinity** data use the identifier `"SMOS-L2C-OS"`.
37+
38+
39+
More about `xcube-smos` can be found in its
40+
[documentation](https://dcs4cop.github.io/xcube-smos/).

docs/index.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ named `smos` to xcube. The data store is used to
1111
access [ESA SMOS](https://earth.esa.int/eogateway/missions/smos) Level-2 data
1212
in form of analysis-ready geospatial datacubes with the dimensions
1313
`time`, `lat`, and `lon`. The datacubes are computed on-the-fly from the SMOS
14-
data archive `s3://EODATA/SMOS` hosted on [CreoDIAS](https://creodias.eu/).
14+
data archive `s3://EODATA/SMOS` hosted on [CREODIAS](https://creodias.eu/).
1515

1616
## Usage
1717

@@ -21,15 +21,18 @@ After installation, data access is as easy as follows:
2121
from xcube.core.store import new_data_store
2222

2323
store = new_data_store("smos", **credentials)
24-
25-
# Get a SMOS Soil Moisture datacube as xarray.Dataset
26-
# To access SMOS Ocean Salinity data use identifier "SMOS-L2C-OS"
27-
dataset = store.open_data(
24+
datacube = store.open_data(
2825
"SMOS-L2C-SM",
2926
time_range=("2022-01-01", "2022-01-06")
3027
)
3128
```
3229

30+
Above, a datacube of type
31+
[xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html)
32+
for SMOS **Soil Moisture** has been obtained.
33+
To access SMOS **Ocean Salinity** data use the identifier `"SMOS-L2C-OS"`.
34+
35+
3336
## Features
3437

3538
The SMOS data is provided using a geographic projection.

docs/start.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
## Credentials
44

5-
The SMOS data store directly accesses SMOS data in its S3 archive on CREODIAS.
6-
Therefore, the data store requires your credentials, which allow you to access
7-
the data. If not already done, create an account on CREODIAS and follow the
8-
instructions to
5+
The xcube SMOS data store directly accesses
6+
[SMOS data](https://creodias.eu/eodata/smos/) in its S3 archive on
7+
[CREODIAS](https://creodias.eu/). Therefore, the data store requires your
8+
credentials. If not already done, create an account on CREODIAS and follow
9+
the instructions to
910
[generate your access key and secret](https://creodias.docs.cloudferro.com/en/latest/general/How-to-generate-ec2-credentials-on-Creodias.html).
1011

1112
## Installation

xcube_smos/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@
1919
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
2020
# DEALINGS IN THE SOFTWARE.
2121

22-
version = "0.2.0.dev0"
22+
version = "0.2.0"

0 commit comments

Comments
 (0)