Merge pull request #337 from CliMA/ne/update_cp

Update to ClimaParams v0.10
CliMA · Feb 29, 2024 · 7163f28 · 7163f28 · nefrathenrici · Feb 29, 2024
2 parents 66f4b8a + ce64d4e
commit 7163f28
Show file tree

Hide file tree

Showing 59 changed files with 72 additions and 76 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,21 +1,21 @@
 name = "CloudMicrophysics"
 uuid = "6a9e3e04-43cd-43ba-94b9-e8782df3c71b"
 authors = ["Climate Modeling Alliance"]
-version = "0.17.0"
+version = "0.18.0"
 
 [deps]
-CLIMAParameters = "6eacf6c3-8458-43b9-ae03-caf5306d3d53"
+ClimaParams = "5c42b081-d73a-476f-9059-fd94b934656c"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 RootSolvers = "7181ea78-2dcb-4de3-ab41-2b8ab5a31e74"
 SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
 Thermodynamics = "b60c26fb-14c3-4610-9d3e-2d17fe7ff00c"
 
 [compat]
-CLIMAParameters = "0.9"
+ClimaParams = "0.10"
 DocStringExtensions = "0.8, 0.9"
 ForwardDiff = "0.10"
 RootSolvers = "0.3, 0.4"
 SpecialFunctions = "1, 2"
-Thermodynamics = "=0.12.3"
+Thermodynamics = "0.12.4"
 julia = "1.6"
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ See [our documentation](https://clima.github.io/CloudMicrophysics.jl/dev/) for t
 CloudMicrophysics.jl is a Julia registered package.
 It depends on a couple of standard Julia packages as well as
   the [Thermodynamics.jl](https://github.com/CliMA/Thermodynamics.jl) and
-  [CLIMAParameters.jl](https://github.com/CliMA/CLIMAParameters.jl)
+  [ClimaParams.jl](https://github.com/CliMA/ClimaParams.jl)
   (two Julia packages developed at [CliMA](https://github.com/CliMA)).
 See the [Project.toml](https://github.com/CliMA/CloudMicrophysics.jl/blob/main/Project.toml)
   for a full list of CloudMicrophysics.jl's dependencies.

diff --git a/box/Alpert_Knopf_2016_backward.jl b/box/Alpert_Knopf_2016_backward.jl
@@ -3,7 +3,7 @@ import Dierckx as DX
 import Random as RD
 import Distributions as DS
 
-import CLIMAParameters
+import ClimaParams
 import Thermodynamics as TD
 import CloudMicrophysics as CM
 import CloudMicrophysics.Parameters as CMP

diff --git a/box/Project.toml b/box/Project.toml
@@ -1,5 +1,5 @@
 [deps]
-CLIMAParameters = "6eacf6c3-8458-43b9-ae03-caf5306d3d53"
+ClimaParams = "5c42b081-d73a-476f-9059-fd94b934656c"
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 CloudMicrophysics = "6a9e3e04-43cd-43ba-94b9-e8782df3c71b"
 Dierckx = "39dd38d3-220a-591b-8e3c-4c3a8c710a94"

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,5 +1,5 @@
 [deps]
-CLIMAParameters = "6eacf6c3-8458-43b9-ae03-caf5306d3d53"
+ClimaParams = "5c42b081-d73a-476f-9059-fd94b934656c"
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 CloudMicrophysics = "6a9e3e04-43cd-43ba-94b9-e8782df3c71b"
 Dierckx = "39dd38d3-220a-591b-8e3c-4c3a8c710a94"
@@ -16,6 +16,5 @@ Thermodynamics = "b60c26fb-14c3-4610-9d3e-2d17fe7ff00c"
 UnicodePlots = "b8865327-cd53-5732-bb35-84acbb429228"
 
 [compat]
-CLIMAParameters = "0.9"
 Documenter = "1.1"
 DocumenterCitations = "1.2"
diff --git a/docs/src/DevelopersGuide.md b/docs/src/DevelopersGuide.md
@@ -90,9 +90,9 @@ The name of the function should be self-explanatory yet brief.
 All functions should have docstrings describing the API, as well as
   documentation focusing on the scientific aspects of what they do.
 All functions should have their own unit, performance and GPU tests.
-All free parameters should be stored in [CLIMAParameters](https://github.com/CliMA/CLIMAParameters.jl).
+All free parameters should be stored in [ClimaParams](https://github.com/CliMA/ClimaParams.jl).
 It is usually faster to prototype defining the free parameters locally,
-  and move them to `CLIMAParameters` at a last step.
+  and move them to `ClimaParams` at a last step.
 
 Other files that may require editing after you make a new function are:
  - `CloudMicrophysics.jl` (found in `src` folder) if you need to include a new source file,
@@ -134,7 +134,7 @@ They can be found in the `test` folder under files named after corresponding sou
 If you create a new function, please also create a new test that checks it.
 If creating a new file for unit tests, make sure you import `Test` and any other necessary libraries.
 There is some boilerplate code needed to create the sets with free parameters
-  based on the default `toml` file from [CLIMAParameters](https://github.com/CliMA/CLIMAParameters.jl).
+  based on the default `toml` file from [ClimaParams](https://github.com/CliMA/ClimaParams.jl).
 
 Some possible tests include checking if the returned values agree with values
   in the literature, if something is smaller/greater at warmer/cooler

diff --git a/docs/src/Microphysics0M.md b/docs/src/Microphysics0M.md
@@ -12,7 +12,7 @@ The ``q_{tot}`` (total water specific humidity) sink due to precipitation
 The threshold for removing excess ``q_{tot}`` is defined either by the
   condensate specific humidity or supersaturation.
 The thresholds and the relaxation timescale are defined in
-  `CLIMAParameters.jl`.
+  `ClimaParams.jl`.
 
 !!! note
 

diff --git a/docs/src/Microphysics1M.md b/docs/src/Microphysics1M.md
@@ -21,7 +21,7 @@ Particles are assumed to follow power-law relationships involving the mass(radiu
 denoted by ``m(r)``, the cross section(radius), denoted by ``a(r)``, and the
 terminal velocity(radius), denoted by ``v_{term}(r)``, respectively.
 The coefficients are defined in the
-  [CLIMAParameters.jl](https://github.com/CliMA/CLIMAParameters.jl) package
+  [ClimaParams.jl](https://github.com/CliMA/ClimaParams.jl) package
   and are shown in the table below.
 For rain and ice they correspond to spherical liquid water drops
   and ice particles, respectively.
@@ -226,7 +226,7 @@ where:
    and is equal to ``1 \, kg/m^3``
 
 The coefficients are defined in
-  [CLIMAParameters.jl](https://github.com/CliMA/CLIMAParameters.jl)
+  [ClimaParams.jl](https://github.com/CliMA/ClimaParams.jl)
 package and are shown in the table below.
 
 |    symbol       |         definition                           | units              | default value                             | reference  |
@@ -275,7 +275,7 @@ Parameterized processes include:
     do not sediment).
 
 Parameters used in the parameterization are defined in
-  [CLIMAParameters.jl](https://github.com/CliMA/CLIMAParameters.jl) package.
+  [ClimaParams.jl](https://github.com/CliMA/ClimaParams.jl) package.
 They consist of:
 
 |    symbol                  |         definition                                        | units                    | default value          | reference |

diff --git a/docs/src/Microphysics2M.md b/docs/src/Microphysics2M.md
@@ -10,7 +10,7 @@ The microphysics variables are expressed as specific humidities [kg/kg] and numb
   - `N_liq` - cloud droplets number density,
   - `N_rai` - raindrops number density.
 The default values of free parameters are defined in
-  [CLIMAParameters](https://github.com/CliMA/CLIMAParameters.jl)
+  [ClimaParams](https://github.com/CliMA/ClimaParams.jl)
   and can be overwritten using the `toml` files.
 
 ## The Seifert and Beheng (2006) parametrization

diff --git a/docs/src/MicrophysicsNonEq.md b/docs/src/MicrophysicsNonEq.md
@@ -11,7 +11,7 @@ The cloud microphysics variables are expressed as specific humidities:
   - `q_ice` - cloud ice specific humidity,
 
 Parameters used in the parameterization are defined in
-  [CLIMAParameters.jl](https://github.com/CliMA/CLIMAParameters.jl) package.
+  [ClimaParams.jl](https://github.com/CliMA/ClimaParams.jl) package.
 They consist of:
 
 |    symbol                  |         definition                                        | units                    | default value          | reference |

diff --git a/docs/src/guides/Parameters.jl b/docs/src/guides/Parameters.jl
@@ -8,12 +8,12 @@
 # `CloudMicrophysics.jl` is designed to allow easy parameter calibrations.
 # As a result, free parameters are not hard-coded in the source code but are instead
 # passed as arguments to functions. The default values are stored in a separate
-# repository [CLIMAParameters.jl](https://github.com/CliMA/CLIMAParameters.jl) in a `toml` file.
+# repository [ClimaParams.jl](https://github.com/CliMA/ClimaParams.jl) in a `toml` file.
 
-# We start by importing the `CLIMAParameters` package and the needed
+# We start by importing the `ClimaParams` package and the needed
 # `CloudMicrophysics.jl` modules. We define the precision type.
 
-import CLIMAParameters as CP
+import ClimaParams as CP
 import CloudMicrophysics.Parameters as CMP
 import CloudMicrophysics.Microphysics1M as CM1
 import CloudMicrophysics.Microphysics2M as CM2

diff --git a/docs/src/plots/ARGplots.jl b/docs/src/plots/ARGplots.jl
@@ -1,13 +1,13 @@
 import Plots
 
 import CloudMicrophysics
-import CLIMAParameters
+import ClimaParams
 import Thermodynamics
 
 const PL = Plots
 const AM = CloudMicrophysics.AerosolModel
 const AA = CloudMicrophysics.AerosolActivation
-const CP = CLIMAParameters
+const CP = ClimaParams
 const CMP = CloudMicrophysics.Parameters
 const TD = Thermodynamics
 

diff --git a/docs/src/plots/ARGplots_fig1.jl b/docs/src/plots/ARGplots_fig1.jl
@@ -1,7 +1,7 @@
 import Plots
 
 import CloudMicrophysics
-import CLIMAParameters
+import ClimaParams
 import Thermodynamics
 
 const PL = Plots

diff --git a/docs/src/plots/Baumgartner2022_fig5.jl b/docs/src/plots/Baumgartner2022_fig5.jl
@@ -3,7 +3,7 @@ import CairoMakie as MK
 
 import CloudMicrophysics as CM
 import Thermodynamics as TD
-import CLIMAParameters as CP
+import ClimaParams as CP
 
 const CMO = CM.Common
 const CMP = CM.Parameters

diff --git a/docs/src/plots/CLOUD_Nucleation_Plots.jl b/docs/src/plots/CLOUD_Nucleation_Plots.jl
@@ -1,6 +1,6 @@
 using Plots
 
-import CLIMAParameters as CP
+import ClimaParams as CP
 import CloudMicrophysics.Parameters as CMP
 import CloudMicrophysics.Nucleation as Nucleation
 

diff --git a/docs/src/plots/Frostenberg_fig1.jl b/docs/src/plots/Frostenberg_fig1.jl
@@ -2,7 +2,7 @@ import Plots as PL
 
 import CloudMicrophysics as CM
 import CloudMicrophysics.HetIceNucleation as IN
-import CLIMAParameters as CP
+import ClimaParams as CP
 import CloudMicrophysics.Parameters as CMP
 
 FT = Float32

diff --git a/docs/src/plots/HomFreezingPlots.jl b/docs/src/plots/HomFreezingPlots.jl
@@ -2,7 +2,7 @@ import CairoMakie as MK
 
 import Thermodynamics as TD
 import CloudMicrophysics as CM
-import CLIMAParameters as CP
+import ClimaParams as CP
 
 const CMO = CM.Common
 const CMI = CM.HomIceNucleation

diff --git a/docs/src/plots/Kirkby_organic_nucleation_plots.jl b/docs/src/plots/Kirkby_organic_nucleation_plots.jl
@@ -1,6 +1,6 @@
 using Plots
 
-import CLIMAParameters as CP
+import ClimaParams as CP
 import CloudMicrophysics.Parameters as CMP
 import CloudMicrophysics.Nucleation as Nucleation
 

diff --git a/docs/src/plots/KnopfAlpert2013_fig5.jl b/docs/src/plots/KnopfAlpert2013_fig5.jl
@@ -1,6 +1,6 @@
 import CairoMakie as MK
 
-import CLIMAParameters
+import ClimaParams
 import Thermodynamics as TD
 import CloudMicrophysics as CM
 import CloudMicrophysics.Common as CMO

diff --git a/docs/src/plots/Microphysics1M_plots.jl b/docs/src/plots/Microphysics1M_plots.jl
@@ -2,7 +2,7 @@ import Plots
 
 import Thermodynamics
 import CloudMicrophysics
-import CLIMAParameters
+import ClimaParams
 
 const PL = Plots
 const CM1 = CloudMicrophysics.Microphysics1M

diff --git a/docs/src/plots/Microphysics2M_plots.jl b/docs/src/plots/Microphysics2M_plots.jl
@@ -1,7 +1,7 @@
 using CairoMakie
 CairoMakie.activate!(type = "svg")
 
-import CLIMAParameters
+import ClimaParams
 import Thermodynamics as TD
 import CloudMicrophysics
 import CloudMicrophysics.Microphysics1M as CM1

diff --git a/docs/src/plots/P3LambdaErrorPlots.jl b/docs/src/plots/P3LambdaErrorPlots.jl
@@ -1,7 +1,7 @@
 import CloudMicrophysics as CM
 import CloudMicrophysics.P3Scheme as P3
 import CloudMicrophysics.Parameters as CMP
-import CLIMAParameters as CP
+import ClimaParams as CP
 import SpecialFunctions as SF
 import RootSolvers as RS
 import CairoMakie as Plt

diff --git a/docs/src/plots/P3SchemePlots.jl b/docs/src/plots/P3SchemePlots.jl
@@ -1,6 +1,6 @@
 import CairoMakie as Plt
 import CloudMicrophysics as CM
-import CLIMAParameters as CP
+import ClimaParams as CP
 import CloudMicrophysics.Parameters as CMP
 import CloudMicrophysics.P3Scheme as P3
 

diff --git a/docs/src/plots/P3ShapeSolverPlots.jl b/docs/src/plots/P3ShapeSolverPlots.jl
@@ -1,6 +1,6 @@
 import CairoMakie as Plt
 import CloudMicrophysics as CM
-import CLIMAParameters as CP
+import ClimaParams as CP
 import CloudMicrophysics.Parameters as CMP
 import CloudMicrophysics.P3Scheme as P3
 

diff --git a/docs/src/plots/RainEvapoartionSB2006.jl b/docs/src/plots/RainEvapoartionSB2006.jl
@@ -4,7 +4,7 @@ import SpecialFunctions as SF
 
 import Thermodynamics as TD
 import CloudMicrophysics as CM
-import CLIMAParameters as CP
+import ClimaParams as CP
 
 import CloudMicrophysics.Parameters as CMP
 import CloudMicrophysics.Common as CO

diff --git a/docs/src/plots/Riccobono_mixed_nucleation_plots.jl b/docs/src/plots/Riccobono_mixed_nucleation_plots.jl
@@ -1,6 +1,6 @@
 using Plots
 
-import CLIMAParameters as CP
+import ClimaParams as CP
 import CloudMicrophysics.Nucleation as Nucleation
 import CloudMicrophysics.Parameters as CMP
 

diff --git a/docs/src/plots/T_vs_wateractivity.jl b/docs/src/plots/T_vs_wateractivity.jl
@@ -2,7 +2,7 @@ import CairoMakie as MK
 
 import Thermodynamics as TD
 import CloudMicrophysics as CM
-import CLIMAParameters as CP
+import ClimaParams as CP
 
 const CMO = CM.Common
 const CMP = CM.Parameters

diff --git a/docs/src/plots/TerminalVelocityComparisons.jl b/docs/src/plots/TerminalVelocityComparisons.jl
@@ -1,6 +1,6 @@
 import Plots as PL
 
-import CLIMAParameters as CP
+import ClimaParams as CP
 
 FT = Float64
 

diff --git a/docs/src/plots/Thersholds_transitions.jl b/docs/src/plots/Thersholds_transitions.jl
@@ -1,11 +1,11 @@
 import Plots
 import CloudMicrophysics
-import CLIMAParameters
+import ClimaParams
 
 const PL = Plots
 const CM1 = CloudMicrophysics.Microphysics1M
 const CM2 = CloudMicrophysics.Microphysics2M
-const CP = CLIMAParameters
+const CP = ClimaParams
 const CMP = CloudMicrophysics.Parameters
 
 FT = Float64

diff --git a/docs/src/plots/compare_vehkamaki_CLOUD_nucleation.jl b/docs/src/plots/compare_vehkamaki_CLOUD_nucleation.jl
@@ -1,6 +1,6 @@
 using Plots
 
-import CLIMAParameters as CP
+import ClimaParams as CP
 import CloudMicrophysics as CM
 import CloudMicrophysics.Parameters as CMP
 import CloudMicrophysics.Nucleation as Nucleation

diff --git a/p3_sandbox/Project.toml b/p3_sandbox/Project.toml
@@ -1,5 +1,5 @@
 [deps]
-CLIMAParameters = "6eacf6c3-8458-43b9-ae03-caf5306d3d53"
+ClimaParams = "5c42b081-d73a-476f-9059-fd94b934656c"
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 CloudMicrophysics = "6a9e3e04-43cd-43ba-94b9-e8782df3c71b"
 KernelAbstractions = "63c18a36-062a-441e-b654-da1e3ab1ce7c"
@@ -8,5 +8,3 @@ RootSolvers = "7181ea78-2dcb-4de3-ab41-2b8ab5a31e74"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 Thermodynamics = "b60c26fb-14c3-4610-9d3e-2d17fe7ff00c"
 
-[compat]
-CLIMAParameters = "0.9"
diff --git a/p3_sandbox/p3_sandbox.jl b/p3_sandbox/p3_sandbox.jl
@@ -1,6 +1,6 @@
 import OrdinaryDiffEq as ODE
 
-import CLIMAParameters
+import ClimaParams
 import CloudMicrophysics.Parameters as CMP
 import CloudMicrophysics.P3Scheme as P3
 import CloudMicrophysics.HetIceNucleation as CMI_het

diff --git a/parcel/Example_Deposition_Nucleation.jl b/parcel/Example_Deposition_Nucleation.jl
@@ -2,7 +2,7 @@ import OrdinaryDiffEq as ODE
 import CairoMakie as MK
 import Thermodynamics as TD
 import CloudMicrophysics as CM
-import CLIMAParameters as CP
+import ClimaParams as CP
 
 # definition of the ODE problem for parcel model
 include(joinpath(pkgdir(CM), "parcel", "Parcel.jl"))

diff --git a/parcel/Example_Immersion_Freezing.jl b/parcel/Example_Immersion_Freezing.jl
@@ -3,7 +3,7 @@ import OrdinaryDiffEq as ODE
 import CairoMakie as MK
 import Thermodynamics as TD
 import CloudMicrophysics as CM
-import CLIMAParameters as CP
+import ClimaParams as CP
 
 # definition of the ODE problem for parcel model
 include(joinpath(pkgdir(CM), "parcel", "Parcel.jl"))

diff --git a/parcel/Example_Jensen_et_al_2022.jl b/parcel/Example_Jensen_et_al_2022.jl
@@ -2,7 +2,7 @@ import OrdinaryDiffEq as ODE
 import CairoMakie as MK
 import Thermodynamics as TD
 import CloudMicrophysics as CM
-import CLIMAParameters as CP
+import ClimaParams as CP
 import Distributions as DS
 import CloudMicrophysics.Parameters as CMP
 

diff --git a/parcel/Example_Liquid_only.jl b/parcel/Example_Liquid_only.jl
@@ -3,7 +3,7 @@ import CairoMakie as MK
 import Thermodynamics as TD
 import CloudMicrophysics as CM
 import CloudMicrophysics.Parameters as CMP
-import CLIMAParameters as CP
+import ClimaParams as CP
 
 include(joinpath(pkgdir(CM), "parcel", "Parcel.jl"))
 

diff --git a/parcel/Example_P3_ice_nuc.jl b/parcel/Example_P3_ice_nuc.jl
@@ -2,7 +2,7 @@ import OrdinaryDiffEq as ODE
 import CairoMakie as MK
 import Thermodynamics as TD
 import CloudMicrophysics as CM
-import CLIMAParameters as CP
+import ClimaParams as CP
 
 # definition of the ODE problem for parcel model
 include(joinpath(pkgdir(CM), "parcel", "Parcel.jl"))