Skip to content

Commit f72b0fa

Browse files
authored
Explain extensions in readme (#459)
1 parent 5e777be commit f72b0fa

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

+30-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,36 @@ multi-layered stacks, and multi-file series of arrays and stacks.
1616

1717
_A RasterStack of EarthEnv HabitatHeterogeneity layers, trimmed to Australia and plotted with Plots.jl_
1818

19-
## Quick start
19+
## Packages extensions and Rasters 0.8 and onwards
20+
21+
On Julia 1.9 we can put additional packages in extensions, so the code only loads when
22+
you load a specific package. Rasters.jl was always intended to work like this,
23+
and its finally possible. This reduced package `using` time from many seconds to well under a second.
24+
25+
But, it means you have to manually load packages you need for each backend or additional
26+
functionality.
27+
28+
For example, to use the GDAL backend, and download files, you now need to do:
29+
30+
```julia
31+
using Rasters, ArchGDAL, RasterDataSources
32+
```
33+
34+
where previously it was just `using Rasters`.
35+
36+
Sources and packages needed:
37+
- `:gdal`: `using ArchGDAL`
38+
- `:netcdf`: `using NCDatasets`
39+
- `:grd`: built-in.
40+
- `:smap`: `using HDF5`
41+
- `:grib`: not yet finished.
42+
43+
Other functionality in extensions:
44+
- Raster data downloads, like `Worldclim{Climate}`: `using RasterDataSources`
45+
- Makie plots: `using Makie`
46+
- Coordinate transformations for gdal rasters: `using CoordinateTransformations`
47+
48+
# Quick start
2049
Install the package by typing:
2150

2251
```julia

0 commit comments

Comments
 (0)