Skip to content

Commit 64e4044

Browse files
modify text
1 parent fddd0eb commit 64e4044

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,19 @@
77
[![Codecov](https://codecov.io/gh/rafaqz/Rasters.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/rafaqz/Rasters.jl)
88
[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
99

10-
[Rasters.jl](https://rafaqz.github.io/Rasters.jl/dev) defines common types and methods for reading, writing and
11-
manipulating rasterized spatial data.
10+
[Rasters.jl](https://rafaqz.github.io/Rasters.jl/dev) is a powerful Julia package for working with spatial raster data. It provides a unified interface for reading, writing, and manipulating raster data. The package extends [DimensionalData.jl](https://rafaqz.github.io/DimensionalData.jl/dev/) to enable intuitive spatial indexing and manipulation of raster data.
1211

13-
These currently include raster arrays like GeoTIFF and NetCDF, R grd files,
14-
multi-layered stacks, and multi-file series of arrays and stacks.
12+
Key features:
13+
- Support for multiple raster formats (e.g. GeoTIFF, NetCDF, GRD)
14+
- Support for multi-layered stacks and multi-file series of arrays
15+
- Lazy loading of large datasets
16+
- Intuitive spatial indexing with named dimensions (X, Y, Time)
17+
- Efficient handling of multi-layered stacks and time series
18+
- Built-in support for coordinate reference systems (CRS)
19+
- High-performance operations optimized for spatial data
1520

1621
# Quick start
22+
1723
Install the package by typing:
1824

1925
```julia
@@ -28,7 +34,7 @@ using Rasters
2834

2935
Using `Rasters` to read GeoTiff or NetCDF files will output something similar to the
3036
following toy examples. This is possible because Rasters.jl extends
31-
[DimensionalData.jl](https://github.com/rafaqz/DimensionalData.jl) so that
37+
[DimensionalData.jl](https://rafaqz.github.io/DimensionalData.jl/dev/) so that
3238
spatial data can be indexed using named dimensions like `X`, `Y` and `Ti` (time)
3339
and e.g. spatial coordinates.
3440

@@ -38,7 +44,7 @@ lon, lat = X(25:1:30), Y(25:1:30)
3844
ti = Ti(DateTime(2001):Month(1):DateTime(2002))
3945
ras = Raster(rand(lon, lat, ti)) # this generates random numbers with the dimensions given
4046
```
41-
```
47+
```julia
4248
6×6×13 Raster{Float64,3} with dimensions:
4349
X Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
4450
Y Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
@@ -61,7 +67,7 @@ Rasters reduces its dependencies to keep the `using` time low.
6167
But, it means you have to manually load packages you need for each
6268
backend or additional functionality.
6369

64-
For example, to use the GDAL backend, and download RasterDataSources files, you now need to do:
70+
For example, to use the GDAL backend, and download RasterDataSources files, you need to do:
6571

6672
```julia
6773
using Rasters, ArchGDAL, RasterDataSources
@@ -77,7 +83,7 @@ Sources and packages needed:
7783
Other functionality in extensions:
7884
- Raster data downloads, like `Worldclim{Climate}`: `using RasterDataSources`
7985
- Makie plots: `using GLMakie` (opengl interactive) or `using CairoMakie` (print) etc.
80-
- Coordinate transformations for gdal rasters: `using CoordinateTransformations`
86+
- Coordinate transformations for GDAL rasters: `using CoordinateTransformations`
8187

8288
## Getting the `lookup` array from dimensions
8389

@@ -97,7 +103,7 @@ Selecting a time slice by `index` is done via
97103
```julia
98104
ras[Ti(1)]
99105
```
100-
```
106+
```julia
101107
6×6 Raster{Float64,2} with dimensions:
102108
X Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
103109
Y Sampled{Int64} 25:1:30 ForwardOrdered Regular Points
@@ -117,7 +123,7 @@ values: 25 26 27 28 29 30
117123
```julia
118124
ras[Ti=1]
119125
```
120-
```
126+
```julia
121127
6×6 Raster{Float64,2} with dimensions:
122128
X Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
123129
Y Sampled{Int64} 25:1:30 ForwardOrdered Regular Points
@@ -139,7 +145,7 @@ or and interval of indices using the syntax `=a:b` or `(a:b)`
139145
```julia
140146
ras[Ti(1:10)]
141147
```
142-
```
148+
```julia
143149
6×6×10 Raster{Float64,3} with dimensions:
144150
X Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
145151
Y Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
@@ -162,7 +168,7 @@ values: [:, :, 1]
162168
```julia
163169
ras[Ti=At(DateTime(2001))]
164170
```
165-
```
171+
```julia
166172
6×6 Raster{Float64,2} with dimensions:
167173
X Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
168174
Y Sampled{Int64} 25:1:30 ForwardOrdered Regular Points

0 commit comments

Comments
 (0)