See here (TBD) for a full documentation. Below is a brief summary of the structure and usage of the package.
The package consists of the following parts:
- Mie code (pymiecoated/)
- Main code (root directory), which can calculate single-scattering and bulk optical properties for both individual wavelengths and wavelength bands
- Generalized spherical function expansion code (gsf/)
Before any spherical aerosol calculations can be done the Mie code needs to be installed.
Starting in the root directory of this repository:
cd pymiecoated
python setup.py installIn some systems the following may be needed instead:
python setup.py install --userThe Mie code does not need to be used directly; runoptics.py calls it as needed. The functions within the module can be used directly to run custom Mie simulations but that is beyond the scope of this README.
The main single-scattering property calculator consists of two parts: calculation at individual wavelengths, and calculation over wavelength bands. The first part is always necessary, the second needs to be run only if wavelength band integrated files are necessary.
To calculate single-scattering properties at individual wavelengths:
python runoptics.py --name path/to/file.jsonWhere file.json defines all of the parameters of the calculation. ".json" can be omitted from the runoptics.py command as a convenience. See JSON examples under geosparticles/ for current GEOS aerosol particles. For users who only want single-scattering properties at individual wavelengths this is all that is needed, and further processing is not needed.
runoptics.py has a few additional options, use
python runoptics.py --helpto see them
To calculate single-scattering properties at wavelength bands:
python runbands.py --filename filename.ncwhere filename.nc should be an output file from runoptics.py
For additional options, see
python runbands.py --helpThe generalized spherical function expansion code is needed to convert the phase functions in the optical tables to be compatible with the VLIDORT radiative transfer software. It is not needed unless you are running VLIDORT directly.
The code uses spher_expan.f code by Michael Mishchenko. Before conversions can be done the Fortran code needs to be compiled.
Starting in the root directory of this repository:
cd gsf
gfortran spher_expan.fOther compilers beyond gfortran may work. Testing has been performed with gfortran 11.2.0 on Gentoo.
To run the conversion code, assuming the code has been compiled and you are in the gsf/ subdirectory:
python rungsf.py --filename ../filename.ncwhere ../filename.nc should be an output file from runoptics.py
For additional options, see
python rungsf.py --helpExternal kernels (e.g. GRASP spheroids) have to be converted into a specific NetCDF format before GEOSmie can use them. For details on the format, see the full documentation.
A tool is provided for converting kernels from GRASP-like format to the GEOSmie-compatible NetCDF file.
python runkernelconversion.py --filename data/kernelconversion/filename.json --dest /path/to/output/directorywhere filename.json is a parameter file that specifies various aspects on how the kernels should be read, and has to be updated if the incoming kernel format changes in virtually any way. Sample JSON files are provided for GRASP kernels (grasp.json) and GRASP-like Saito et al. kernels (saito.json).