Merge pull request #70 from jbisits/removeRasterHistograms

Remove `RasterHistogram` module as it now has its own package

Author: jbisits

Project.toml

@@ -1,7 +1,7 @@
 name = "OceanRasterConversions"
 uuid = "07ff2621-03e0-4bfb-9812-e5d28c6dbff8"
 authors = ["Josef I. Bisits <[email protected]>"]
-version = "0.4.0"
+version = "0.5.0"
 
 [deps]
 DimensionalData = "0703355e-b756-11e9-17c0-8b28908087d0"
@@ -12,7 +12,6 @@ MakieCore = "20f20a25-4f0e-4fdf-b5d1-57303727442b"
 NCDatasets = "85f8d34a-cbdd-5861-8df4-14fed0d494ab"
 Rasters = "a3a2b9e3-a471-40c9-b274-f788e487c689"
 RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
-Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 
 [compat]
@@ -23,7 +22,6 @@ MakieCore = "0.6"
 NCDatasets = "0.12"
 Rasters = "0.6, 0.7, 0.8"
 RecipesBase = "1.3"
-Reexport = "1"
 StatsBase = "0.33, 0.34"
 julia = "1.6"
 

README.md

@@ -6,11 +6,7 @@
 [![codecov](https://codecov.io/gh/jbisits/OceanRasterConversions.jl/branch/main/graph/badge.svg?token=XEAWB8IHFV)](https://codecov.io/gh/jbisits/OceanRasterConversions.jl)
 
 [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`](https://jbisits.github.io/OceanRasterConversions.jl/dev/modules/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`](https://jbisits.github.io/OceanRasterConversions.jl/dev/modules/RasterHistograms/), empirical distribution fitting for `Raster` data structures aiming to provide functionality similar to python's [xhistogram](https://xhistogram.readthedocs.io/en/latest/index.html) for [xarray](https://docs.xarray.dev/en/stable/) in Julia.
+[`OceanVariableConversions`](https://jbisits.github.io/OceanRasterConversions.jl/stable), provides 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.
 
 ## Using the package
 
@@ -30,10 +26,3 @@ julia> using Rasters, OceanRasterConversions
 ```
 
 into the repl.
-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`.

docs/make.jl

@@ -11,11 +11,9 @@ end
 
 example_pages = [
    "Converting ocean variables" => "literated/ocean_variable_conversion.md",
-   "Histograms from `Raster`s" => "literated/raster_histograms.md"
 ]
 module_pages = [
     "OceanVariableConversions" => "modules/OceanVariableConversions.md",
-    "RasterHistograms"         => "modules/RasterHistograms.md"
 ]
 library_pages = [
     "Function index" => "library/function_index.md"

docs/src/index.md

@@ -2,10 +2,10 @@
 
 [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`](@ref ocean_conv_vars_module), 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`](@ref raster_hist_module), empirical distribution fitting for `Raster` data structures aiming to provide functionality similar to python's [xhistogram](https://xhistogram.readthedocs.io/en/latest/index.html) for [xarray](https://docs.xarray.dev/en/stable/) in Julia.
+OceanRasterConversions.jl converts and computes ocean varaibles that are saved as `Raster` data structures using [GibbsSeaWater.jl](https://github.com/TEOS-10/GibbsSeaWater.jl).
+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](https://www.teos-10.org/pubs/gsw/html/gsw_front_page.html) standard variables of absolute salinity and conservative temperature to accurately calculate further variables like seawater density.
+Further conversions and other water mass transformation procedures will be added in the future.
 
 If there are any bugs and/or feature request please raise an [issue](https://github.com/jbisits/OceanRasterConversions.jl/issues) on the GitHub page.
 

docs/src/library/function_index.md

@@ -1,33 +1,15 @@
-# Function index
+# [Function index](@id ovc_func_index)
 
-## [OceanVariableConversions](@id ovc_func_index)
-
-### OceanVariableConversions exported functions
-
-```@autodocs
-Modules = [OceanVariableConversions]
-Private = false
-```
-
-### OceanVariableConversions private functions
-
-```@autodocs
-Modules = [OceanVariableConversions]
-Public = false
-```
-
-## [RasterHistograms](@id rh_func_index)
-
-### RasterHistograms exported functions
+## OceanRasterConversions exported functions
 
 ```@autodocs
-Modules = [RasterHistograms]
+Modules = [OceanRasterConversions]
 Private = false
 ```
 
-### RasterHistograms private functions
+## OceanRasterConversions private functions
 
 ```@autodocs
-Modules = [RasterHistograms]
+Modules = [OceanRasterConversions]
 Public = false
 ```

docs/src/modules/OceanVariableConversions.md

@@ -1,15 +1,8 @@
-# [OceanVarbiableConversion](@id ocean_conv_vars_module)
+# [Converting Ocean Variables](@id ocean_conv_vars_module)
 
-## Overview
+## Package workings
 
-This module converts and computes ocean varaibles that are saved as `Raster` data structures using [GibbsSeaWater.jl](https://github.com/TEOS-10/GibbsSeaWater.jl).
-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](https://www.teos-10.org/pubs/gsw/html/gsw_front_page.html) standard variables of absolute salinity and conservative temperature to accurately calculate further variables like seawater density.
-
-Further conversions and other water mass transformation procedures will be added in the future.
-
-## Module workings
-
-This module will convert the variables practical salinity and potential temperature into absolute salinity and conservative temperature.
+This package will convert the variables practical salinity and potential temperature into absolute salinity and conservative temperature.
 In doing so a pressure variable is needed, so this is created and returned in the `RasterStack`.
 A density variable (either in-situ or potential referenced to a user input) is computed and added to the `RasterStack`.
 See the example for how the module can be used.

docs/src/modules/RasterHistograms.md

@@ -1,7 +1,7 @@
 # # [Converting the practical salinity and potential temperature from ECCOv4r4 model output.](@id converting_variables_example)
 # First, add the required dependencies
 using Rasters, NCDatasets, Plots, Downloads
-using OceanRasterConversions.OceanVariableConversions
+using OceanRasterConversions
 # and download model output from [ECCOv4r4](https://ecco-group.org/products-ECCO-V4r4.htm).
 # This data is the daily average 0.5 degree salinity and temperature model output. To reproduce
 # this example, an Earthdata acount is needed to download the data.

examples/ocean_variable_conversion.jl

@@ -1,11 +1,24 @@
+"""
+Module to convert variables depth, practical salinity and potential temperature to the
+TEOS-10 standard variables pressure, absolute salinity and conservative temperature
+(respectively) from a `Raster`, `RasterStack`  or `RasterSeries`. A few chosen seawater
+variables can then be computed from these state variables.
+"""
 module OceanRasterConversions
 
-using Reexport
+using Rasters, GibbsSeaWater, DocStringExtensions
+
+export
+    convert_ocean_vars,
+    depth_to_pressure, Sₚ_to_Sₐ, θ_to_Θ,
+    get_ρ, get_σₚ, get_α, get_β
 
-include("oceanvariableconversions.jl")
-include("oceanvariabledistributions.jl")
 
-@reexport using OceanRasterConversions.OceanVariableConversions
-@reexport using OceanRasterConversions.RasterHistograms
+include("oceanvariableconversions.jl")
+include("z_to_p.jl")
+include("sp_to_sa.jl")
+include("theta_to_Theta.jl")
+include("seawaterdensity.jl")
+include("alphaandbeta.jl")
 
 end #module