Merge tag 'v0.6.0' into extra-utils-2

[Diff since v0.5.0](v0.5.0...v0.6.0)

**Closed issues:**
- Physical constants (#26)

**Merged pull requests:**
- Create (1) physical constants, and (2) symbolic dimensions object (#32) (@MilesCranmer)

Author: MilesCranmer

.github/workflows/CI.yml

@@ -33,13 +33,15 @@ jobs:
       - uses: julia-actions/cache@v1
       - uses: julia-actions/julia-buildpkg@v1
       - name: "Run tests"
+        shell: bash
         run: |
           julia --color=yes --project=. -e 'import Pkg; Pkg.add("Coverage")'
           julia --color=yes --threads=auto --check-bounds=yes --depwarn=yes --code-coverage=user --project=. -e 'import Pkg; Pkg.test(coverage=true)'
           DQ_TEST_UPREFERRED=true julia --color=yes --threads=auto --check-bounds=yes --depwarn=yes --code-coverage=user --project=. -e 'import Pkg; Pkg.test(coverage=true)'
           julia --color=yes --project=. coverage.jl
       - name: "Coveralls"
         uses: coverallsapp/github-action@v2
+        if: matrix.version == '1'
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           file: lcov.info

Project.toml

@@ -1,12 +1,13 @@
 name = "DynamicQuantities"
 uuid = "06fc5a27-2a28-4c7c-a15d-362465fb6821"
 authors = ["MilesCranmer <[email protected]> and contributors"]
-version = "0.5.0"
+version = "0.6.0"
 
 [deps]
 Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Requires = "ae029012-a4dd-5104-9daa-d747884805df"
+SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 Tricks = "410a4b4d-49e4-4fbc-ab6d-cb71b17b3775"
 
 [weakdeps]

docs/make.jl

@@ -39,7 +39,11 @@ makedocs(;
     ),
     pages=[
         "Home" => "index.md",
-        "API" => "api.md",
+        "Utilities" => "api.md",
+        "Units" => "units.md",
+        "Constants" => "constants.md",
+        "Symbolic Units" => "symbolic_units.md",
+        "Types" => "types.md",
     ]
 )
 

docs/src/api.md

@@ -1,13 +1,4 @@
-# Usage
-
-## Types
-
-```@docs
-Quantity
-Dimensions
-```
-
-## Utilities
+# Utilities
 
 The two main general utilities for working
 with quantities are `ustrip` and `dimension`:
@@ -17,7 +8,7 @@ ustrip
 dimension
 ```
 
-### Accessing dimensions
+## Accessing dimensions
 
 Utility functions to extract specific dimensions are as follows:
 
@@ -37,49 +28,6 @@ Pages   = ["utils.jl"]
 Filter  = t -> !(t in [ustrip, dimension, ulength, umass, utime, ucurrent, utemperature, uluminosity, uamount])
 ```
 
-## Units
-
-The two main functions for working with units are `uparse` and `u_str`:
-
-```@docs
-@u_str
-uparse
-```
-
-### Available units
-
-The base SI units are as follows.
-Instead of calling directly, it is recommended to access them via
-the `@u_str` macro, which evaluates the expression
-in a namespace with all the units available.
-
-```@docs
-Units.m
-Units.g
-Units.s
-Units.A
-Units.K
-Units.cd
-Units.mol
-```
-
-Several derived SI units are available as well:
-
-```@docs
-Units.Hz
-Units.N
-Units.Pa
-Units.J
-Units.W
-Units.C
-Units.V
-Units.F
-Units.Ω
-Units.T
-Units.L
-Units.bar
-```
-
 ## Internals
 
 ### FixedRational
@@ -88,4 +36,3 @@ Units.bar
 DynamicQuantities.FixedRational
 DynamicQuantities.denom
 ```
-

docs/src/constants.md

@@ -0,0 +1,46 @@
+
+# Units
+
+Many common physical constants are available as well:
+
+```@docs
+Constants.c
+Constants.h
+Constants.hbar
+Constants.e
+Constants.k_B
+Constants.N_A
+Constants.eV
+Constants.R
+Constants.F
+Constants.sigma_sb
+Constants.alpha
+Constants.u
+Constants.G
+Constants.mu_0
+Constants.eps_0
+Constants.m_e
+Constants.m_p
+Constants.m_n
+Constants.a_0
+Constants.k_e
+Constants.Ryd
+```
+
+## Astronomical constants
+
+```@docs
+Constants.M_earth
+Constants.M_sun
+Constants.M_jup
+Constants.R_earth
+Constants.R_jup
+Constants.R_sun
+Constants.L_sun
+Constants.L_bol0
+Constants.sigma_T
+Constants.au
+Constants.pc
+Constants.ly
+Constants.atm
+```