fix issue with NetCDF by downgrading, expand the readme a little bit

markmbaum · Feb 1, 2022 · 7bd2e0d · 7bd2e0d
1 parent d7a3734
commit 7bd2e0d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "GEOCLIM"
 uuid = "3dbb98da-0543-4a00-be75-dcc1e89fb417"
 authors = ["Mark Baum <markmbaum@protonmail.com>", "Minmin Fu <mjfu@g.harvard.edu>"]
-version = "0.1.7"
+version = "0.1.9"
 
 [deps]
 BasicInterpolators = "26cce99e-4866-4b6d-ab74-862489e035e0"
@@ -15,7 +15,6 @@ UnPack = "3a884ed6-31ef-47d7-9d2a-63182c4928ed"
 [compat]
 BasicInterpolators = "0.6"
 MultiAssign = "0.1"
-NetCDF = "0.11"
 Roots = "1"
 StaticArrays = "1"
 UnPack = "1"

diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ julia> ] add https://github.com/markmbaum/GEOCLIM.jl
 It's recommended that you do so in an [environment](https://pkgdocs.julialang.org/v1.2/environments/).
 
 ------
-### Usage
+#### Weathering Functions
 
 There are three weathering functions corresponding to the formulations listed above
 1. `godderis(r, T, k, Eₐ, T₀)`
@@ -46,6 +46,9 @@ There are three weathering functions corresponding to the formulations listed ab
 
 where `r` is runoff and `T` is temperature. You can find explanations of all the other arguments and their units in the [main source file](https://github.com/markmbaum/GEOCLIM.jl/blob/main/src/GEOCLIM.jl) or the referenced papers. These primary functions have no type restrictions.
 
+------
+#### Climatologies
+
 The rest of the package is focused on two dimensional grids of results from GCM simulations and is structured around the `Climatology` type. Read GCM results into a `Climatology` by calling the constructor
 ```
 Climatology(fnr,   #runoff file name
@@ -63,6 +66,15 @@ where the file names point to NetCDF files.
 
 Then each of the weathering functions can be called on a `Climatology` by passing the struct instead of `r` and `T`, returning a global sum of weathering in each grid cell.
 
+For example, to compute the global `mac` weathering estimate with a climatology variable called `clim`,
+```
+mac(clim, pCO2, Tₑ, T₀, pCO2₀)
+```
+The temperature and runoff are already in the struct, so you only need to provide the other weathering arguments.
+
+------
+#### Climatology Interpolation and Weathering Equilibria
+
 Multiple climatologies can be linked into a `ClimatologyInterpolator` to easily perform cell-wise interpolation. The constructor is
 ```
 ClimatologyInterpolator(𝒞::AbstractVector{Climatology}, x::AbstractVector{<:Real})