Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RemoteSensingTools/vSmartMOM.jl
A full end-to-end modular software suite for radiative transfer and related atmospheric analysis
https://github.com/RemoteSensingTools/vSmartMOM.jl
Last synced: 3 months ago
JSON representation
A full end-to-end modular software suite for radiative transfer and related atmospheric analysis
- Host: GitHub
- URL: https://github.com/RemoteSensingTools/vSmartMOM.jl
- Owner: RemoteSensingTools
- License: apache-2.0
- Created: 2020-07-02T16:53:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-27T13:04:29.000Z (6 months ago)
- Last Synced: 2024-06-11T17:31:11.998Z (5 months ago)
- Language: Julia
- Size: 145 MB
- Stars: 41
- Watchers: 5
- Forks: 10
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- open-sustainable-technology - vSmartMOM.jl - A full end-to-end modular software suite for radiative transfer and related atmospheric analysis. (Atmosphere / Radiative Transfer)
README
vSmartMOM.jl
An end-to-end modular software suite for vectorized atmospheric radiative transfer calculations, based on the Matrix Operator Method.
Written in Julia.
[](https://github.com/RemoteSensingTools/vSmartMOM.jl/actions/workflows/AutomatedTests.yml/)
[](https://RemoteSensingTools.github.io/vSmartMOM.jl/dev/)
[](https://github.com/RemoteSensingTools/vSmartMOM.jl/blob/master/LICENSE)
[](https://doi.org/10.21105/joss.04575)
[](https://github.com/RemoteSensingTools/vSmartMOM.jl/commits/master)
Installation •
Modules (vSmartMOM, Absorption, Scattering) •
Support •
License
This project aims to revamp and modernize key atmospheric remote sensing tools. Specifically, it will enable the fast computation of atmospheric optical properties, full-polarized radiative transfer simulations, and commonly-used inversion routines.
The core of the code is based on recent publications:
- Sanghavi, S., Davis, A. B., & Eldering, A. (2014). vSmartMOM: A vector matrix operator method-based radiative transfer model linearized with respect to aerosol properties. Journal of Quantitative Spectroscopy and Radiative Transfer, 133, 412-433. [Download](https://www.sciencedirect.com/science/article/pii/S0022407313003592)
- Sanghavi, S. V., Martonchik, J. V., Davis, A. B., & Diner, D. J. (2013). Linearization of a scalar matrix operator method radiative transfer model with respect to aerosol and surface properties. Journal of Quantitative Spectroscopy and Radiative Transfer, 116, 1-16. [Download](https://www.sciencedirect.com/science/article/pii/S0022407312004633)
- Sanghavi, S., & Natraj, V. (2013). Using analytic derivatives to assess the impact of phase function Fourier decomposition technique on the accuracy of a radiative transfer model. Journal of Quantitative Spectroscopy and Radiative Transfer, 119, 137-149. [Download](https://www.sciencedirect.com/science/article/pii/S0022407313000071)
- Sanghavi, S. (2014). Revisiting the Fourier expansion of Mie scattering matrices in generalized spherical functions. Journal of Quantitative Spectroscopy and Radiative Transfer, 136, 16-27. [Download](https://www.sciencedirect.com/science/article/pii/S0022407313004962)
By taking advantage of modern software tools, such as GPU acceleration and HPC computing, the software suite significantly accelerates computationally-intensive calculations and models, while keeping the interface easy-to-use for researchers and students.
## Installation
vSmartMOM can be installed using the Julia package manager. From the Julia REPL, type `]` to enter the Pkg REPL mode and run
```julia
pkg> add vSmartMOM
```
## Modules
**Note: This section provides only a quick overview of the available modules in vSmartMOM.jl.**
For in-depth examples, tutorials, and implementation details, please see the complete Documentation.
### vSmartMOM
The vSmartMOM module allows end-to-end simulation of radiative transfer (RT) throughout Earth's atmosphere and surface. Specifically, it:
1. Enables 1D vectorized plane-parallel RT modeling based on the Matrix Operator Method.
2. Incorporates fast, high fidelity simulations of scattering atmospheres containing haze and clouds – including pressure- and temperature-resolved absorption profiles of gaseous species in the atmosphere.
3. Enables GPU-accelerated computations of the resulting hyperspectral reflectances/transmittances.
Key functions:
- `parameters_from_yaml(filepath::String)`: Load a custom set of RT parameters from a YAML file.
- `default_parameters()`: Load a default set of RT parameters.
- `model_from_parameters(parameters::vSmartMOM_Parameters)`: Using the parameters, calculate derived parameters that will be used in the main RT code. The derived parameters include cross-section profiles, scattering phase functions, etc.
- `rt_run(model::vSmartMOM_Model)`: Use the defined model to perform RT simulation.
### vSmartMOM.Absorption
This module enables absorption cross-section calculations of atmospheric gases at different pressures, temperatures, and broadeners (Doppler, Lorentzian, Voigt). It uses the HITRAN energy transition database for calculations. While it enables lineshape calculations from scratch, it also allows users to create and save an interpolator object at specified wavelength, pressure, and temperature grids. It can perform these computations either on CPU or GPU.
Key functions:
- `read_hitran(filepath::String)`: Creates a HitranTable struct from the fixed-width HITRAN file with transitions.
- `make_hitran_model(hitran::HitranTable, broadening::AbstractBroadeningFunction, ...)`: Create a HitranModel struct that holds all of the model parameters needed to perform a absorption cross-section (transitions, broadening type, wing_cutoff, etc.)
- `make_interpolation_model(hitran::HitranTable, broadening::AbstractBroadeningFunction, )`: Similar to creating a HitranModel, but this will perform the interpolation at the given wavelength, pressure, and temperature grids and store the interpolator in InterpolationModel.
- `absorption_cross_section(model::AbstractCrossSectionModel, grid::AbstractRange{<:Real}, pressure::Real, temperature::Real, ...)`: Performs an absorption cross-section calculation with the given model (HitranModel or InterpolationModel), at a given wavelength grid, pressure and temperature
### vSmartMOM.Scattering
This module enables scattering phase-function calculation of atmospheric aerosols with different size distributions, incident wavelengths, and refractive indices. It can perform the calculation using either the Siewert NAI-2 or Domke PCW methods ([Suniti Sanghavi 2014](https://www.sciencedirect.com/science/article/pii/S0022407313004962)).
Key functions:
- `make_univariate_aerosol(size_distribution::ContinuousUnivariateDistribution, r_max, nquad_radius::Int, nᵣ, nᵢ`: Create an aerosol object with size distribution and complex refractive index.
- `make_mie_model(computation_type::AbstractFourierDecompositionType, aerosol::AbstractAerosolType, λ::Real, polarization::AbstractPolarizationType, truncation_type::AbstractTruncationType, ...)`: Create a MieModel struct that holds all of the model parameters needed to perform a phase function calculation (computation type, aerosol, incident wavelength, etc. )
- `compute_aerosol_optical_properties(model::MieModel)`: Compute the aerosol optical properties using the specified model parameters
## How to Contribute
vSmartMOM.jl is a growing package and thus feedback from users like you are highly appreciated. To report bugs or suggest new features in vSmartMOM.jl, please create GitHub [Issues](https://github.com/RemoteSensingTools/vSmartMOM.jl/issues). To contribute to the package, please feel free to create a [Pull Request](https://github.com/RemoteSensingTools/vSmartMOM.jl/pulls).
If you have any questions about the methods used or would like to chat with us, please feel free to shoot us an email here.
## Acknowledgements
This project is being developed in the Christian Frankenberg and Paul Wennberg labs at Caltech and is largely based on papers and ideas by Suniti Sanghavi from NASA/JPL, with support from the Schmidt Academy for Software Engineering (SASE).
## Copyright Notice
Apache 2.0 License; Copyright 2022, by the California Institute of Technology. United States Government Sponsorship acknowledged.