Aggregated updates

.github/workflows/ci.yml

@@ -5,20 +5,23 @@ on:
     tags: ["*"]
   pull_request:
     branches: [master]
+
 concurrency:
   # Skip intermediate builds: always.
   # Cancel intermediate builds: only if it is a pull request build.
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
 jobs:
+
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         version:
-          - '1.0'
+          - '1.6'
           - '1'
           - 'nightly'
         os:
@@ -28,8 +31,8 @@ jobs:
         arch:
           - x64
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
@@ -42,34 +45,16 @@ jobs:
       - uses: codecov/codecov-action@v1
         with:
           file: lcov.info
+
   aqua:
     name: Aqua tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
           version: '1'
-      - uses: julia-actions/cache@v1
+      - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@v1
       - run: julia -e 'using Pkg; Pkg.add("Aqua")'
       - run: julia --project=@. -e 'using Aqua, DustExtinction; Aqua.test_all(DustExtinction, ambiguities=false)'
-  docs:
-    name: Documentation
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
-        with:
-          version: '1'
-      - uses: julia-actions/cache@v1
-      - run: |
-          julia --project=docs -e '
-            using Pkg
-            Pkg.develop(PackageSpec(path=pwd()))
-            Pkg.instantiate()'
-      - run: julia --project=docs docs/make.jl
-        env:
-          GKSwstype: nul
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: Documentation
+
+on:
+  push:
+    branches: [master]
+    tags: ["*"]
+  pull_request:
+    branches: [master]
+
+jobs:
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+      - uses: julia-actions/cache@v2
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GKSwstype: nul
+          DATADEPS_ALWAYS_ACCEPT: true
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

Project.toml

@@ -19,7 +19,7 @@ FITSIO = "0.13.0, 0.14, 0.15, 0.16.1, 0.17"
 Parameters = "0.12"
 Unitful = "0.17.0, 1"
 UnitfulAstro = "0.3.0, 0.4, 1"
-julia = "1.0"
+julia = "1.6"
 
 [extras]
 Measurements = "eff96d63-e80a-5855-80a2-b1b0885c5ab7"

README.md

@@ -17,61 +17,63 @@ Documentation: [DustExtinction](https://JuliaAstro.github.io/DustExtinction.jl/s
 
 ## Installation
 
-From package manager (``` ]``` key)
+From package manager (`]` key)
 
-``` add DustExtinction```
+```julia-repl
+pkg> add DustExtinction
+```
 
 ## Usage
 
 Color laws:
 
-```julia
+```julia-repl
 julia> using DustExtinction
 
 julia> CCM89(Rv=3.1)(4000)
 1.4645557029425842
 
 julia> CCM89(Rv=3.1).([4000, 5000])
-2-element Array{Float64,1}:
+2-element Vector{Float64}:
  1.46456
  1.12225
 ```
 
 Dust maps:
 
-```julia
+```julia-repl
 julia> dustmap = SFD98Map()
 SFD98Map("[...]")
 
 julia> dustmap(0.1, 0.1)
 0.793093095733043
 
 julia> dustmap.([0.1, 0.2], [0.1, 0.2])
-2-element Array{Float64,1}:
+2-element Vector{Float64}:
  0.793093
  0.539507
 ```
 
 Reddening:
 
-```julia
+```julia-repl
 julia> wave = [4000., 5000.]
-2-element Array{Float64,1}:
+2-element Vector{Float64}:
  4000.0
  5000.0
 
 julia> flux = [1.0, 1.5]
-2-element Array{Float64,1}:
+2-element Vector{Float64}:
  1.0
  1.5
 
 julia> red = redden.(CCM89, wave, flux; Av=0.3, Rv=3.1)
-2-element Array{Float64,1}:
+2-element Vector{Float64}:
  0.6671958182723856
  1.1000733242882896
 
 julia> deredden.(CCM89(Rv=3.1), wave, red; Av=0.3)
-2-element Array{Float64,1}:
+2-element Vector{Float64}:
  1.0
  1.5
 ```

docs/Project.toml

@@ -5,3 +5,11 @@ Measurements = "eff96d63-e80a-5855-80a2-b1b0885c5ab7"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 UnitfulAstro = "6112ee07-acf9-5e0f-b108-d242c714bf9f"
+
+[compat]
+Documenter = "1"
+LaTeXStrings = "1"
+Measurements = "2"
+Plots = "1"
+Unitful = "1"
+UnitfulAstro = "1"

docs/make.jl

@@ -7,7 +7,8 @@ makedocs(modules = [DustExtinction],
     sitename = "DustExtinction.jl",
     format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
     authors = "Kyle Barbary, Mosé Giordano, Miles Lucas",
-    pages = pages
+    pages = pages,
+    warnonly = [:missing_docs],
 )
 
 deploydocs(repo = "github.com/JuliaAstro/DustExtinction.jl.git", push_preview = true)

docs/src/assets/m14.bib → docs/src/assets/bibtex/m14.bib

@@ -1,9 +1,5 @@
 @ARTICLE{2014A&A...564A..63M,
-       author = {{Ma{\'\i}z Apell{\'a}niz}, J. and {Evans}, C.~J. and {Barb{\'a}}, R.~H. and
-         {Gr{\"a}fener}, G. and {Bestenlehner}, J.~M. and {Crowther}, P.~A. and
-         {Garc{\'\i}a}, M. and {Herrero}, A. and {Sana}, H. and
-         {Sim{\'o}n-D{\'\i}az}, S. and {Taylor}, W.~D. and {van Loon}, J. Th. and
-         {Vink}, J.~S. and {Walborn}, N.~R.},
+       author = {{Ma{\'\i}z Apell{\'a}niz}, J. and {Evans}, C.~J. and {Barb{\'a}}, R.~H. and {Gr{\"a}fener}, G. and {Bestenlehner}, J.~M. and {Crowther}, P.~A. and {Garc{\'\i}a}, M. and {Herrero}, A. and {Sana}, H. and {Sim{\'o}n-D{\'\i}az}, S. and {Taylor}, W.~D. and {van Loon}, J. Th. and {Vink}, J.~S. and {Walborn}, N.~R.},
         title = "{The VLT-FLAMES Tarantula Survey. XVI. The optical and NIR extinction laws in 30 Doradus and the photometric determination of the effective temperatures of OB stars}",
       journal = {\aap},
      keywords = {open clusters and associations: individual: 30 Doradus, dust, extinction, Magellanic Clouds, stars: early-type, stars: fundamental parameters, Astrophysics - Astrophysics of Galaxies, Astrophysics - Cosmology and Nongalactic Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics},

docs/src/color_laws.md

@@ -7,6 +7,7 @@ The following empirical laws allow us to model the reddening of light as it trav
 DocTestSetup = quote
     using DustExtinction, Random
     Random.seed!(1)
+    ENV["UNITFUL_FANCY_EXPONENTS"] = false
 end
 ```
 
@@ -17,17 +18,15 @@ Color laws are constructed and then used as a function for passing wavelengths.
 ```jldoctest
 julia> CCM89(Rv=3.1)(4000)
 1.464555702942584
-
 ```
 
 These laws can be applied across higher dimension arrays using the `.` operator
 
 ```jldoctest
 julia> CCM89(Rv=3.1).([4000, 5000])
-2-element Array{Float64,1}:
+2-element Vector{Float64}:
  1.464555702942584
  1.1222468788993019
-
 ```
 
 these laws return magnitudes, which we can apply directly to flux by mulitplication with a base-2.5 logarithmic system (because astronomers are fun):
@@ -46,8 +45,8 @@ julia> flux = 1e-8 .* wave .+ 1e-2
 0.01004:3.3333333333333333e-6:0.01005
 
 julia> redden.(CCM89, wave, flux; Av=0.3)
-4-element Array{Float64,1}:
- 0.006698646015454752
+4-element Vector{Float64}:
+ 0.00669864601545475
  0.006918253926353551
  0.007154659823737299
  0.007370491272731541
@@ -65,7 +64,7 @@ The color laws also have built-in support for uncertainties using [Measurements.
 julia> using Measurements
 
 julia> CCM89(Rv=3.1).([4000. ± 10.5, 5000. ± 10.2])
-2-element Array{Measurement{Float64},1}:
+2-element Vector{Measurement{Float64}}:
  1.4646 ± 0.0033
  1.1222 ± 0.003
 
@@ -77,8 +76,8 @@ and also support units via [Unitful.jl](https://github.com/painterqubits/unitful
 julia> using Unitful, UnitfulAstro
 
 julia> mags = CCM89(Rv=3.1).([4000u"angstrom", 0.5u"μm"])
-2-element Array{Gain{Unitful.LogInfo{:Magnitude,10,-2.5},:?,Float64},1}:
- 1.4645557029425837 mag
+2-element Vector{Gain{Unitful.LogInfo{:Magnitude, 10, -2.5}, :?, Float64}}:
+  1.464555702942584 mag
  1.1222468788993019 mag
 
 ```
@@ -92,28 +91,28 @@ julia> wave = range(0.3, 1.0, length=5)u"μm"
 (0.3:0.175:1.0) μm
 
 julia> err = randn(length(wave))
-5-element Array{Float64,1}:
-  0.2972879845354616
-  0.3823959677906078
- -0.5976344767282311
- -0.01044524463737564
- -0.839026854388764
+5-element Vector{Float64}:
+ -0.07058313895389791
+  0.5314767537831963
+ -0.806852326006714
+  2.456991333983293
+  1.1648740735275196
 
 julia> flux = @.(300 / ustrip(wave)^4 ± err)*u"Jy"
-5-element Array{Quantity{Measurement{Float64},𝐌*𝐓⁻²,Unitful.FreeUnits{(Jy,),𝐌*𝐓⁻²,nothing}},1}:
-  37037.04 ± 0.3 Jy
-  5893.14 ± 0.38 Jy
-  1680.61 ± -0.6 Jy
- 647.598 ± -0.01 Jy
-   300.0 ± -0.84 Jy
+5-element Vector{Quantity{Measurement{Float64}, 𝐌 𝐓^-2, Unitful.FreeUnits{(Jy,), 𝐌 𝐓^-2, nothing}}}:
+ 37037.037 ± -0.071 Jy
+     5893.14 ± 0.53 Jy
+    1680.61 ± -0.81 Jy
+        647.6 ± 2.5 Jy
+        300.0 ± 1.2 Jy
 
 julia> redden.(CCM89, wave, flux; Av=0.3)
-5-element Array{Quantity{Measurement{Float64},𝐌*𝐓⁻²,Unitful.FreeUnits{(Jy,),𝐌*𝐓⁻²,nothing}},1}:
-    22410.8 ± 0.18 Jy
-    4229.74 ± 0.27 Jy
-    1337.12 ± 0.48 Jy
- 554.3349 ± 0.0089 Jy
-     268.31 ± 0.75 Jy
+5-element Vector{Quantity{Measurement{Float64}, 𝐌 𝐓^-2, Unitful.FreeUnits{(Jy,), 𝐌 𝐓^-2, nothing}}}:
+ 22410.804 ± 0.043 Jy
+    4229.74 ± 0.38 Jy
+    1337.12 ± 0.64 Jy
+       554.3 ± 2.1 Jy
+       268.3 ± 1.0 Jy
 
 ```
 
@@ -203,7 +202,7 @@ F19
 
 ### Maiz Apellaniz et al. (2014)
 
-![](assets/m14_plot.svg)
+![](assets/M14_plot.svg)
 
 ```@docs
 M14
@@ -216,6 +215,7 @@ redden
 deredden
 DustExtinction.ExtinctionLaw
 DustExtinction.bounds
+DustExtinction.checkbounds
 ```
 
 ### Fittable Extinction Laws
@@ -230,6 +230,12 @@ FM90
 
 ### Mixture Extinction Laws
 
+#### Gordon et al. (2003)
+
+```@docs
+G03_SMCBar
+```
+
 #### Gordon et al. (2016)
 
 ![](assets/G16_fixed_f_A_plot.svg)

docs/src/dust_maps.md

@@ -22,7 +22,7 @@ julia> b = range(-π/2, π/2, length=5)
 -1.5707963267948966:0.7853981633974483:1.5707963267948966
 
 julia> [dustmap(l[i], b[j]) for i in 1:length(l), j in 1:length(b)]
-5×5 Array{Float64,2}:
+5×5 Matrix{Float64}:
  0.0159853  0.105782    1.40486  0.0158918  0.0119615
  0.0159853  0.0268289   3.47788  0.0654852  0.0119615
  0.0159853  0.0343457  99.6976   0.103875   0.0119615