Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ Manifest.toml
/examples/*.md
!/examples/README.md

# Generated data/cache for optional advanced examples.
/examples/radiative_transfer/*.nc
/examples/radiative_transfer/*.mat
/examples/radiative_transfer/*.jls

# Editor and OS metadata
.DS_Store
.idea/
Expand Down
21 changes: 15 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

Work on top of `v0.4.0`. Includes a breaking change to solver selection, so the
next release is expected to be `v0.5.0`.
No unreleased changes yet.

## [0.5.0] - 2026-06-05

### Added

Expand All @@ -25,9 +26,16 @@ next release is expected to be `v0.5.0`.
`Iterative(EBCM; stable = true)`.
- **Performance benchmark suite** and a PR benchmark CI workflow
(AirspeedVelocity).
- **`examples/` folder** with five runnable Pluto notebooks — shapes gallery,
angular scattering & polarization, orientation averaging, solver landscape, and
spectral sensitivity — rendered into the documentation site.
- **`examples/` folder** with six runnable Pluto notebooks — shapes gallery,
solver landscape, angular scattering & polarization, orientation averaging,
and spectral sensitivity, plus a rain-radar observables example adapted from
[`@xiongyuup`](https://github.com/xiongyuup)'s
[PR #3](https://github.com/JuliaRemoteSensing/TransitionMatrices.jl/pull/3)
with water/ice refractive-index fits and a multi-frequency
brightness-temperature lookup — rendered into the documentation site.
- **Optional radiative-transfer workflow example** with synthetic WRF-like
NetCDF generation and a WRF-style dual-pol radar pipeline under
`examples/radiative_transfer/`.

### Changed

Expand Down Expand Up @@ -76,7 +84,8 @@ next release is expected to be `v0.5.0`.

- Initial release.

[Unreleased]: https://github.com/JuliaRemoteSensing/TransitionMatrices.jl/compare/v0.4.0...HEAD
[Unreleased]: https://github.com/JuliaRemoteSensing/TransitionMatrices.jl/compare/v0.5.0...HEAD
[0.5.0]: https://github.com/JuliaRemoteSensing/TransitionMatrices.jl/compare/v0.4.0...v0.5.0
[0.4.0]: https://github.com/JuliaRemoteSensing/TransitionMatrices.jl/compare/v0.3.1...v0.4.0
[0.3.1]: https://github.com/JuliaRemoteSensing/TransitionMatrices.jl/compare/v0.3.0...v0.3.1
[0.3.0]: https://github.com/JuliaRemoteSensing/TransitionMatrices.jl/compare/v0.2.0...v0.3.0
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "TransitionMatrices"
uuid = "057c4241-e127-4181-840e-6b4b92e6eef5"
version = "0.4.0"
version = "0.5.0"
authors = ["Gabriel Wu <wuzihua@pku.edu.cn> and contributors"]

[deps]
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ The precision types `Double64`, `Float128`, `ComplexF128`, `Arb`, and `Acb`
are re-exported by `TransitionMatrices.jl` and can be directly used after
`using TransitionMatrices`.

The `0.4` compatibility line uses `Quadmath.jl` 1.x and `Wigxjpf.jl` 0.3.x.
The `0.5` compatibility line uses `Quadmath.jl` 1.x and `Wigxjpf.jl` 0.3.x.
31 changes: 27 additions & 4 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,32 @@ using Documenter
# the examples/ environment in its own Pluto worker.
const NB_DIR = normpath(joinpath(@__DIR__, "..", "examples"))
const NB_OUT = joinpath(@__DIR__, "src", "examples")
const NOTEBOOKS = ["shapes_gallery.jl", "angular_scattering.jl",
"orientation_averaging.jl", "solver_landscape.jl", "spectral_sensitivity.jl"]
const NB_PAGES = ["examples/" * replace(nb, ".jl" => ".md") for nb in NOTEBOOKS]
const NOTEBOOKS = ["shapes_gallery.jl", "solver_landscape.jl",
"angular_scattering.jl", "orientation_averaging.jl", "spectral_sensitivity.jl",
"rain_radar.jl"]

function notebook_title(nb)
in_markdown = false
for line in eachline(joinpath(NB_DIR, nb))
s = strip(line)
if !in_markdown
startswith(s, "md\"\"\"") || continue
in_markdown = true
s = strip(s[6:end])
elseif startswith(s, "\"\"\"")
in_markdown = false
continue
end
startswith(s, "# ") && return String(strip(s[3:end]))
end
String(replace(splitext(nb)[1], "_" => " "))
end

const NB_PAGE_PATHS = ["examples/" * replace(nb, ".jl" => ".md") for nb in NOTEBOOKS]
const NB_PAGES = [
notebook_title(nb) => path
for (nb, path) in zip(NOTEBOOKS, NB_PAGE_PATHS)
]

function build_examples()
mkpath(NB_OUT)
Expand Down Expand Up @@ -47,7 +70,7 @@ makedocs(;
prettyurls = get(ENV, "CI", "false") == "true",
canonical = "https://JuliaRemoteSensing.github.io/TransitionMatrices.jl",
edit_link = "main",
size_threshold_ignore = NB_PAGES, # rendered notebooks embed large plots
size_threshold_ignore = NB_PAGE_PATHS, # rendered notebooks embed large plots
assets = String[]),
pages = [
"Home" => "index.md",
Expand Down
Loading
Loading