Merge branch 'main' into asinghvi17-patch-7

Author: asinghvi17

README.md

@@ -1,22 +1,26 @@
 # Rasters
-
+<img src="docs/src/assets/logo.png" align="right" width="30%"></img>
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/rafaqz/Rasters.jl/blob/main/LICENSE)
 [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://rafaqz.github.io/Rasters.jl/stable)
 [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://rafaqz.github.io/Rasters.jl/dev)
 [![CI](https://github.com/rafaqz/Rasters.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/rafaqz/Rasters.jl/actions/workflows/ci.yml)
 [![Codecov](https://codecov.io/gh/rafaqz/Rasters.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/rafaqz/Rasters.jl)
-[![Aqua.jl Quality Assurance](https://img.shields.io/badge/Aquajl-%F0%9F%8C%A2-aqua.svg)](https://github.com/JuliaTesting/Aqua.jl)
-[![Downloads](https://shields.io/endpoint?url=https://pkgs.genieframework.com/api/v1/badge/Rasters&label=Downloads)](https://pkgs.genieframework.com?packages=Rasters)
-
-<img src="/docs/src/assets/logo.png" align="right" width="30%"></img>
+[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
+[![Downloads](https://img.shields.io/badge/dynamic/json?url=http%3A%2F%2Fjuliapkgstats.com%2Fapi%2Fv1%2Fmonthly_downloads%2FRasters&query=total_requests&suffix=%2Fmonth&label=Downloads)](https://juliapkgstats.com/pkg/Rasters)
 
-[Rasters.jl](https://rafaqz.github.io/Rasters.jl/dev) defines common types and methods for reading, writing and
-manipulating rasterized spatial data. 
+[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.
 
-These currently include raster arrays like GeoTIFF and NetCDF, R grd files, 
-multi-layered stacks, and multi-file series of arrays and stacks. 
+Key features:
+- Support for multiple raster formats (e.g. GeoTIFF, NetCDF, GRD)
+- Support for multi-layered stacks and multi-file series of arrays
+- Lazy loading of large datasets
+- Intuitive spatial indexing with named dimensions (X, Y, Time)
+- Efficient handling of multi-layered stacks and time series
+- Built-in support for coordinate reference systems (CRS)
+- High-performance operations optimized for spatial data
 
 # Quick start
+
 Install the package by typing:
 
 ```julia
@@ -31,7 +35,7 @@ using Rasters
 
 Using `Rasters` to read GeoTiff or NetCDF files will output something similar to the
 following toy examples. This is possible because Rasters.jl extends
-[DimensionalData.jl](https://github.com/rafaqz/DimensionalData.jl) so that
+[DimensionalData.jl](https://rafaqz.github.io/DimensionalData.jl/dev/) so that
 spatial data can be indexed using named dimensions like `X`, `Y` and `Ti` (time)
 and e.g. spatial coordinates.
 
@@ -41,7 +45,7 @@ lon, lat = X(25:1:30), Y(25:1:30)
 ti = Ti(DateTime(2001):Month(1):DateTime(2002))
 ras = Raster(rand(lon, lat, ti)) # this generates random numbers with the dimensions given
 ```
-```
+```julia
 6×6×13 Raster{Float64,3} with dimensions: 
   X Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
   Y Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
@@ -64,7 +68,7 @@ Rasters reduces its dependencies to keep the `using` time low.
 But, it means you have to manually load packages you need for each 
 backend or additional functionality.
 
-For example, to use the GDAL backend, and download RasterDataSources files, you now need to do:
+For example, to use the GDAL backend, and download RasterDataSources files, you need to do:
 
 ```julia
 using Rasters, ArchGDAL, RasterDataSources
@@ -80,7 +84,7 @@ Sources and packages needed:
 Other functionality in extensions:
 - Raster data downloads, like `Worldclim{Climate}`: `using RasterDataSources`
 - Makie plots: `using GLMakie` (opengl interactive) or `using CairoMakie` (print) etc.
-- Coordinate transformations for gdal rasters: `using CoordinateTransformations`
+- Coordinate transformations for GDAL rasters: `using CoordinateTransformations`
 
 ## Getting the `lookup` array from dimensions
 
@@ -100,7 +104,7 @@ Selecting a time slice by `index` is done via
 ```julia
 ras[Ti(1)]
 ```
-```
+```julia
 6×6 Raster{Float64,2} with dimensions: 
   X Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
   Y Sampled{Int64} 25:1:30 ForwardOrdered Regular Points
@@ -120,7 +124,7 @@ values:      25         26          27          28         29          30
 ```julia
 ras[Ti=1]
 ```
-```
+```julia
 6×6 Raster{Float64,2} with dimensions: 
   X Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
   Y Sampled{Int64} 25:1:30 ForwardOrdered Regular Points
@@ -142,7 +146,7 @@ or and interval of indices using the syntax `=a:b` or `(a:b)`
 ```julia
 ras[Ti(1:10)]
 ```
-```
+```julia
 6×6×10 Raster{Float64,3} with dimensions: 
   X Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
   Y Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
@@ -165,7 +169,7 @@ values: [:, :, 1]
 ```julia
 ras[Ti=At(DateTime(2001))]
 ```
-```
+```julia
 6×6 Raster{Float64,2} with dimensions: 
   X Sampled{Int64} 25:1:30 ForwardOrdered Regular Points,
   Y Sampled{Int64} 25:1:30 ForwardOrdered Regular Points

docs/make.jl

@@ -3,6 +3,7 @@ using Documenter, Rasters, Plots, Logging, Statistics, Dates,
 import Makie, CairoMakie
 using DocumenterVitepress
 using Rasters.LookupArrays, Rasters.Dimensions
+import Shapefile, DataFrames, NaturalEarth # to avoid precompilation in doctests
 
 # Don't output huge svgs for Makie plots
 CairoMakie.activate!(type = "png")
@@ -45,7 +46,7 @@ makedocs(
     ),
     source = "src",
     build = "build",
-    warnonly=true,
+    warnonly=false,
 )
 
 # Enable logging to console again