Preliminary outline for reading/writing docs #536
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Dont worry about the tests ucdavis (worldclim) is down, as usual |
|
Note we cant write to hdf5 ;) |
asinghvi17
reviewed
Oct 2, 2024
Comment on lines
+63
to
+72
| # # write Raster to a JDL2 file. | ||
|
|
||
| # JLD2 saves and loads Julia data structures in a format comprising a subset of HDF5, | ||
| # without any dependency on the HDF5 C library. The save and load functions, provided | ||
| # by FileIO, provide a mechanism to read and write data from a JLD2 file. | ||
| Pkg.add("FileIO"); | ||
| using FileIO | ||
|
|
||
| filename = tempname() * ".jld2" | ||
| save(filename, ras) |
There was a problem hiding this comment.
I'd be a bit leery of serializing rasters using JLD2, since it's not robust if anything in the stack changes (DD, DiskArrays, etc). Maybe we should add a warning that this is only suitable for extremely short term storage?
| filename = tempname() * ".grd" | ||
| write(filename, ras) | ||
|
|
||
| # # write Raster using GDAL[requires adding ArchGDAL.jl] |
There was a problem hiding this comment.
Suggested change
| # # write Raster using GDAL[requires adding ArchGDAL.jl] | |
| # # Write Raster using GDAL (requires ArchGDAL.jl) |
| # create a Raster | ||
| ras = Raster(rand(lon, lat); crs=proj) # this generates random numbers with the dimensions given | ||
|
|
||
| # # write Raster to a grd file |
There was a problem hiding this comment.
Suggested change
| # # write Raster to a grd file | |
| # # Write Raster to a `.grd` file |
| # Some metadata may be lost in formats that store little metadata, or where | ||
| # metadata conversion has not been completely implemented. | ||
|
|
||
| # # create a Raster dataset for saving |
There was a problem hiding this comment.
Suggested change
| # # create a Raster dataset for saving | |
| # # Create a Raster to save |
| using Rasters | ||
|
|
||
| # specify the coodinate reference system [crs]. | ||
| proj = "+proj=longlat +datum=WGS84 +no_defs +type=crs" |
There was a problem hiding this comment.
This needs to be wrapped in GFT.ProjString
| @@ -0,0 +1,73 @@ | |||
| # # Writing rasters to Disk | |||
|
|
|||
| # Rasters.jl supports writing datasets to disk in several differnt formats. grd files are | |||
There was a problem hiding this comment.
Suggested change
| # Rasters.jl supports writing datasets to disk in several differnt formats. grd files are | |
| # Rasters.jl supports writing datasets to disk in several different formats. `.grd` files are |
| # # Writing rasters to Disk | ||
|
|
||
| # Rasters.jl supports writing datasets to disk in several differnt formats. grd files are | ||
| # currently the only supported file format that does not require loading an extension. |
There was a problem hiding this comment.
Suggested change
| # currently the only supported file format that does not require loading an extension. | |
| # supported with no extra steps, but all others require loading an extension. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a preliminary edit to update the reading and writing docs.
I'm hoping to get help getting the NCDatasets and HDF5 examples working that are located at the end of the
writing.jlfile.