Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #41

Merged
merged 19 commits into from
Apr 12, 2023
Merged

Update documentation #41

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
343d015
Begin docs update
jbisits Apr 10, 2023
30aa30d
Create raster_histograms.jl
jbisits Apr 10, 2023
71572ae
Update documentation
jbisits Apr 11, 2023
6f04673
Update to docs
jbisits Apr 11, 2023
d702dc2
Remove random from doc test
jbisits Apr 11, 2023
355fbd5
Remove CairoMakie for test plotting
jbisits Apr 11, 2023
b9fd171
Merge branch 'main' into joey-updatedocs
jbisits Apr 11, 2023
5466791
Revert to my compat for DimensionsalData.jl
jbisits Apr 11, 2023
508a0b0
Missing docstring
jbisits Apr 11, 2023
6c66844
DocStringExtensions and more docs
jbisits Apr 11, 2023
1e4f91e
Update OceanRasterConversions.jl
jbisits Apr 11, 2023
60e9d8d
Wrong place for DocStringExtensions
jbisits Apr 11, 2023
5424b80
FIx links (hopefully) and add function Library
jbisits Apr 11, 2023
e893d10
Fix spelling
jbisits Apr 11, 2023
f88acf2
Merge branch 'main' into joey-updatedocs
jbisits Apr 12, 2023
4b01217
Merge normalize and links to function index
jbisits Apr 12, 2023
f891bf2
Fixes
jbisits Apr 12, 2023
8b7545a
Up version + display methods for functions
jbisits Apr 12, 2023
87e7709
remove methods
jbisits Apr 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Revert to my compat for DimensionsalData.jl
  • Loading branch information
@jbisits
jbisits committed Apr 11, 2023
commit 546679161b39e56123b5963733233b6cd4c3be72
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"

[compat]
DimensionalData = "=0.24.7, 0.24"
DimensionalData = "=0.24.7"
GibbsSeaWater = "^0.1.2"
MakieCore = "0.6"
Rasters = "^0.5.0"
Expand Down
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@
[![Build Status](https://github.com/jbisits/OceanRasterConversions.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/jbisits/OceanRasterConversions.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/jbisits/OceanRasterConversions.jl/branch/main/graph/badge.svg?token=XEAWB8IHFV)](https://codecov.io/gh/jbisits/OceanRasterConversions.jl)

This package converts and computes ocean variables that are saved as `Raster` data structures using [GibbsSeaWater.jl](https://github.com/TEOS-10/GibbsSeaWater.jl).
[Rasters.jl](https://github.com/rafaqz/Rasters.jl) provides excellent reading, writing and manipulation of geospatial data.
Typically, the salt and temperature variables from ocean models or observational data are practical salinity and potential temperature so conversions must be to the TEOS-10 standard variables of absolute salinity and conservative temperature to accurately calculate further variables like seawater density.
[Rasters.jl](https://rafaqz.github.io/Rasters.jl/dev/) provides excellent methods for reading, analysing and plotting for geospatial data.
This package contains modules that are useful for analysing oceanic data (either model output or gridded observations) and is designed to be used in conjunction with Rasters.jl.
The modules are:

- `OceanVariableConversions`, conversion and computation (using [TEOS-10](https://www.teos-10.org/pubs/gsw/html/gsw_front_page.html)) of ocean variables that are `Raster` data structures; and
- `RasterHistograms`, empirical distribution fitting for `Raster` data structures.

## Using the package

Expand All @@ -27,4 +30,10 @@ julia> using Rasters, OceanRasterConversions
```

into the repl.
To see a list of the exported functions from OceanRasterConversions.jl see the [documentation](https://jbisits.github.io/OceanRasterConversions.jl/dev/#Functions-exported-from-OceanRasterConversions).
The modules can also be loaded individually, to avoid loading in unnecessary funcitons into the workspace, by

```julia
julia> using OceanRasterConversions.RasterHistograms
```

and similarly for `OceanRasterConversions.OceanVariableConversions`.
1 change: 1 addition & 0 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ If there are any bugs and/or feature request please raise an [issue](https://git
!!! info
This package assumes that the `missingval = missing` in the `Raster`, `RasterStack` or `RasterSeries`.
By default `missingval = missing` in Rasters.jl, so as long as the `missingval` has not been changed the modules in this package will work.