Skip to content

Commit 0d2bdd8

Browse files
Update README.md
1 parent aed32f5 commit 0d2bdd8

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ Features include:
2525

2626

2727

28-
Here is minimal example for loading GRIB or NetCDF files.
28+
Here is minimal example for loading files using `CommonDataModel`:
2929

3030
``` julia
3131
import CommonDataModel as CDM
32-
import SomeDatasets # where SomeDatasets is either GRIBDatasets or NCDatasets
32+
import SomeDatasets # where SomeDatasets is either GRIBDatasets, NCDatasets, ZarrDatasets,...
3333

3434
ds = SomeDatasets.Dataset("file_name")
3535

@@ -50,23 +50,21 @@ title = ds.attrib["title"] # or CDM.attribs(ds)["title"]
5050
close(ds)
5151
```
5252

53-
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`.
54-
55-
53+
Most users would typically import [`GRIBDatasets`](https://github.com/JuliaGeo/GRIBDatasets.jl), [`NCDatasets`](https://github.com/Alexander-Barth/NCDatasets.jl)... directly and not `CommonDataModel`.
5654

5755
# File conversions
5856

59-
By implementing a common interface, GRIB files can be converted to NetCDF files using
60-
`NCDatasets.write`:
57+
By implementing a common interface, files can be converted from one format to another using the `write` function.
58+
For example GRIB files can be converted to NetCDF (or Zarr) files:
6159

6260
```julia
63-
using NCDatasets
61+
using NCDatasets # or ZarrDatasets
6462
using GRIBDatasets
6563
using Downloads: download
6664

6765
grib_file = download("https://github.com/JuliaGeo/GRIBDatasets.jl/raw/98356af026ea39a5ec0b5e64e4289105492321f8/test/sample-data/era5-levels-members.grib")
6866
netcdf_file = "test.nc"
6967
NCDataset(netcdf_file,"c") do ds
70-
NCDatasets.write(ds,GRIBDataset(grib_file))
68+
write(ds,GRIBDataset(grib_file))
7169
end
7270
```

0 commit comments

Comments
 (0)