Skip to content

Commit f4da189

Browse files
Update README.md
1 parent 01a7ff0 commit f4da189

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@ This package is at a very early state of developpement.
1010
Here is minimal example for loading GRIB or NetCDF files.
1111

1212
``` julia
13+
import CommonDataModel as CDM
1314
import SomeDatasets # where SomeDatasets is either GRIBDatasets or NCDatasets
1415

1516
ds = SomeDatasets.Dataset("file_name")
1617

1718
# ntime is the number of time instances
18-
ntime = ds.dim["time"]
19+
ntime = CDM.dims(ds)["time"]
1920

2021
# create an array-like structure v corresponding to variable temperature
2122
v = ds["temperature"]
@@ -27,11 +28,14 @@ subdata = v[10:30,30:5:end]
2728
data = v[:,:]
2829

2930
# load a global attribute
30-
title = ds.attrib["title"]
31+
title = CDM.attribs(ds)["title"]
3132
close(ds)
3233
```
3334

34-
Most users would typically import `GRIBDatasets` and `NCDatasets` directly and not `CommonDataModel`. One should import `CommonDataModel` only to extent the functionality of `GRIBDatasets` and `NCDatasets`.
35+
Most users would typically import [`GRIBDatasets`](https://github.com/JuliaGeo/GRIBDatasets.jl) and [`NCDatasets`](https://github.com/Alexander-Barth/NCDatasets.jl) directly and not `CommonDataModel`. One should import `CommonDataModel` only to extent the functionality of `GRIBDatasets` and `NCDatasets`.
36+
37+
As a proof-of-concept, there is also an [`TIFFDatasets`](https://github.com/Alexander-Barth/TIFFDatasets.jl) package for GeoTIFF files.
38+
3539

3640

3741

0 commit comments

Comments
 (0)