Skip to content

Commit

Permalink
transferred UnitSystem
Browse files Browse the repository at this point in the history
  • Loading branch information
chakravala committed Dec 4, 2020
1 parent 161adbb commit 542a98e
Show file tree
Hide file tree
Showing 8 changed files with 489 additions and 1,210 deletions.
4 changes: 3 additions & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
name = "Geophysics"
uuid = "74efdf00-b554-44e1-bd21-abb9281d951c"
authors = ["Michael Reed"]
version = "0.2.2"
version = "0.3.0"

[deps]
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
AbstractTensors = "a8e43f4a-99b7-5565-8bf1-0165161caaea"
UnitSystems = "3a241a3c-2137-41aa-af5e-1388e404ca09"

[compat]
julia = "1"
AbstractTensors = "0.6"
UnitSystems = "0.1"

[extras]
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
Expand Down
17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,7 @@ Other simple geophysical data about planets, can be added in a collaborative eff
Complicated models will be excluded from this package, as it is only intended to provide a minimal foundation for geophysical data and constants of various planets, more complicated models should be built separately in packages to build on `Geophysics`.
For example, some geographic conditions can be calculated externally, and then Geophysics is used to load that data.

## Unit systems

A `UnitSystem` is a consistent set of dimensional values selected to accomodate a particular use case or standardization. In total, five fundamental constants `kB,ħ,𝘤,μ,mₑ` are used to specify a specific unit system. These are the constants of `boltzmann`, `planckreduced`, `lightspeed`, `permeability`, and `electronmass`. Different choices of natural units or physical measurements result in a variety of unit systems optimized for many purposes.

```Julia
UnitSystem{kB,ħ,𝘤,μ₀,mₑ}
```

Standardized for engineering based on fundamental constants: `kB` Boltzmann's constant, `ħ` reduced Planck's constant, `𝘤` speed of light, `μ₀` vacuum permeability, and `mₑ` electron rest mass.
Primarily the `Metric` SI unit system is used in addition to the historic `English` engineering unit system.
These constants induce derived values for `avogadro`, `boltzmann`, `universal`, `planck`, `planckreduced`, `lightspeed`, `planckmass`, `atomicmass`, `protonmass`, `electronmass`, `newton`, `einstein`, `permeability`, `permittivity`, `coulomb`, and
additional constants `stefan`, `radiationintensity`, `impedance`, `charge`, `magneton`, `conductance`, `faraday`, `magneticflux`, `josephson`, `klitzing`, `hartree`, `rydberg`, `bohr`, `bohrreduced`, and `molarmass`.

https://geophysics.crucialflow.com/dev/units

Additional reference `UnitSystem` variants `CGS`, `CGS2019`, `SI2019`, `CODATA`, `Conventional`; along with several natural atomic units based on the fine structure constant `1/αinv` and the gravitational coupling constant `αG` (`Planck`, `PlanckGauss`, `Stoney`, `Hartree`, `Rydberg`, `Schrodinger`, `Electronic`, `Natural`, `NaturalGauss`, `QCD`, `QCDGauss`, and `QCDoriginal`).
This package depends only on [AbstractTensors.jl](https://github.com/chakravala/AbstractTensors.jl) and [UnitSystems.jl](https://github.com/chakravala/UnitSystems.jl).

## References
* R. A. Minzer and W. S. Ripley, [The ARDC Model Atmosphere, 1956](https://www.cia.gov/library/readingroom/docs/CIA-RDP81-01043R002600070006-6.pdf), ARDC (1956)
Expand Down
4 changes: 2 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# This file is part of Geophysics.jl. It is licensed under the AGPL license
# Grassmann Copyright (C) 2019 Michael Reed

using Documenter, AbstractTensors, Geophysics
using Documenter, UnitSystems, AbstractTensors, Geophysics

makedocs(
modules = [Geophysics],
modules = [Geophysics,UnitSystems],
doctest = false,
format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
sitename = "Geophysics.jl",
Expand Down
Loading

2 comments on commit 542a98e

@chakravala
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/25809

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.3.0 -m "<description of version>" 542a98ebf5711504f18f4c670f6b80cec48d0729
git push origin v0.3.0

Please sign in to comment.