| Name | MANTA-Ray-optics JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | None |
| Summary | MANTA-Ray (Modified Absorption of Non-spherical Tiny Aggregates in the Rayleigh regime) is a model that calculates the absorption efficiency and absorption cross-section of fractal aggregates. |
| upload_time | 2024-08-21 21:24:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.0.1 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
MANTA-Ray (<ins>**M**</ins>odified <ins>**A**</ins>bsorption of <ins>**N**</ins>on-spherical <ins>**T**</ins>iny <ins>**A**</ins>ggregates in the <ins>**Ray**</ins>leigh regime) is a model that calculates the absorption efficiency and absorption cross-section of fractal aggregates. It is a very powerful and fast tool that can be used to estimate the amount of absorption that occurs in dust and haze particles of any shape, provided that the electromagnetic radiation is in the Rayleigh regime (see below for strict definition), often in the context of planetary atmospheres or protoplanetary disks. It obtains values within 10-20% of those calculated by a rigorous benchmark model (the discrete dipole approximation), but is $10^{13}$ times faster. It is provided here as a python function. For full details of the methodology, or if the code is useful in your project, please cite the paper below:
"MANTA-Ray: Supercharging Speeds for Calculating the Optical Properties of Fractal Aggregates in the Long-Wavelength Limit" (2024), Lodge, M.G., Wakeford H.R., and Leinhardt, Z.M.
# Getting started
The easiest way to run MANTA-Ray is to install it into your python environment using pip:
pip install MANTA_Ray_optics
Then import the functions into your python code:
from MANTA_Ray_optics import MANTA_Ray
The inputs to the functions are:
1) wavelength: the wavelength ($\lambda$) of the electromagnetic radiation (in μm).
2) radius: the particle radius ($R$) (in μm) -- see note below*.
3) d_f: the fractal dimension ($d_f$) of the aggregate. The code has been tested for values between $d_f=$ 1.2 (linear) and 2.7 (compact). See section "The Model" below for more details.
4) n: the real component of refractive index
5) k: the imaginary component of refractive index
*Because the aggregates are non-spherical, they do not have a radius. To represent the physical size of the particle, we use the radius of a <i>sphere that has exactly the same volume</i> as the fractal aggregate (i.e. the radius if the aggregate material was squashed/compacted into a sphere).
Note that to be in the Rayleigh regime, and for this theory to work, it is assumed that $\lambda \geq 100R$, and the code will return an error message if this condition is not true.
To use each of functions, just provide the above inputs, strictly in that order. For example, to determine the absorption efficiency of an aggregate of fractal dimension 1.8, with a radius of 0.5 μm, at a wavelength of 100 μm, and assuming a refractive index $m=n+k$ i $=3+0.5$ i:
wavelength = 100 # in um
radius = 0.5 # in um
d_f = 1.8
n = 3
k = 0.5
Q_abs = MANTA_Ray.find_Q_abs(wavelength, radius, d_f, n, k) # calculate Q_abs
print(Q_abs)
If MANTA-Ray installed correctly, you should see:
Q_abs = 0.021153387751343056
Two functions are provided:
1) find_Q_abs: calculates absorption efficiency $Q_{abs,MR}$ (Eq. 5 in Lodge et al. 2024)
2) find_C_abs: calculates absorption cross-section (where $C_{abs}=Q_{abs} \pi R^2$)
Both functions use the same input variables:
Q_abs = MANTA_Ray.find_Q_abs(wavelength, radius, d_f, n, k)
C_abs = MANTA_Ray.find_C_abs(wavelength, radius, d_f, n, k)
If a pip install fails (or simply if you prefer), you could copy and paste the functions from MANTA_Ray.py directly into your code and use them in the same way.
# The Model
This section provides a brief overview of the model, but for a full explanation and more details, please read Lodge et al. 2024.
Transmission Electron Microscope (TEM) images of solid matter in Earth's atmosphere shows that they often form very complex shapes, which we call fractal aggregates. Their exact shape depends on the material and conditions under which they form. Typically, we characterise them by a single number -- their fractal dimension $d_f$:
<p align="center">
<img src="https://github.com/user-attachments/assets/7060caea-1465-45dd-9f64-74a351b0733b" alt="drawing" width="400" />
</p>
In the image above the two aggregates are both composed of 24 "monomers" (individual spheres), but in different arrangements. These shapes are characterised in many optical models by $d_f$ which is a number between 1 (representing a straight line) and 3 (compact and perfectly spherical).
Modelling the optical properties of complex shapes is difficult, and Mie theory is often used (which assumes that the particles are spherical). However, this can often be a significant underestimate of the amount of absorption (by factors of up to 1,000 -- see Lodge et al. 2024). Calculating the optical properties for the true aggregate shape can be done using a rigorous code such as the discrete dipole approximation (DDA -- Draine and Flatau, 1994), but this is usually incredibly time consuming (and unfeasible for use in forward models that wish to study many wavelengths/particle sizes). In contrast, MANTA-Ray estimates absorption cross-sections with average accuracies of 10-20% compared to DDA, but $10^{13}$ times faster. It works for any wavelength, particle size, and refractive index $m$ within 1+0.01i< $m$ <11+11i. It is strictly only for use in the Rayleigh Regime (where the wavelength $\lambda$ is significantly larger than the radius $R$ of a sphere of equivalent volume to the aggregate -- here we define this regime as $\lambda \geq 100R$).
Raw data
{
"_id": null,
"home_page": null,
"name": "MANTA-Ray-optics",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.0.1",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Matt Lodge <matthew.g.lodge@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e8/06/dd264e89da62c5fab5ac8825e485c67d7bda2922cc90df51a20d6e846480/manta_ray_optics-1.0.2.tar.gz",
"platform": null,
"description": "\n\nMANTA-Ray (<ins>**M**</ins>odified <ins>**A**</ins>bsorption of <ins>**N**</ins>on-spherical <ins>**T**</ins>iny <ins>**A**</ins>ggregates in the <ins>**Ray**</ins>leigh regime) is a model that calculates the absorption efficiency and absorption cross-section of fractal aggregates. It is a very powerful and fast tool that can be used to estimate the amount of absorption that occurs in dust and haze particles of any shape, provided that the electromagnetic radiation is in the Rayleigh regime (see below for strict definition), often in the context of planetary atmospheres or protoplanetary disks. It obtains values within 10-20% of those calculated by a rigorous benchmark model (the discrete dipole approximation), but is $10^{13}$ times faster. It is provided here as a python function. For full details of the methodology, or if the code is useful in your project, please cite the paper below:\n\n \"MANTA-Ray: Supercharging Speeds for Calculating the Optical Properties of Fractal Aggregates in the Long-Wavelength Limit\" (2024), Lodge, M.G., Wakeford H.R., and Leinhardt, Z.M.\n\n# Getting started\n\nThe easiest way to run MANTA-Ray is to install it into your python environment using pip:\n\n\tpip install MANTA_Ray_optics\n\nThen import the functions into your python code:\n\n\tfrom MANTA_Ray_optics import MANTA_Ray\n\nThe inputs to the functions are:\n\n1) wavelength: the wavelength ($\\lambda$) of the electromagnetic radiation (in \u03bcm).\n2) radius: the particle radius ($R$) (in \u03bcm) -- see note below*.\n3) d_f: the fractal dimension ($d_f$) of the aggregate. The code has been tested for values between $d_f=$ 1.2 (linear) and 2.7 (compact). See section \"The Model\" below for more details.\n4) n: the real component of refractive index\n5) k: the imaginary component of refractive index\n\n*Because the aggregates are non-spherical, they do not have a radius. To represent the physical size of the particle, we use the radius of a <i>sphere that has exactly the same volume</i> as the fractal aggregate (i.e. the radius if the aggregate material was squashed/compacted into a sphere). \n\nNote that to be in the Rayleigh regime, and for this theory to work, it is assumed that $\\lambda \\geq 100R$, and the code will return an error message if this condition is not true.\n\nTo use each of functions, just provide the above inputs, strictly in that order. For example, to determine the absorption efficiency of an aggregate of fractal dimension 1.8, with a radius of 0.5 \u03bcm, at a wavelength of 100 \u03bcm, and assuming a refractive index $m=n+k$ i $=3+0.5$ i:\n\n\twavelength = 100 # in um\n \tradius = 0.5 # in um\n\td_f = 1.8\t\t\n \tn = 3\n\tk = 0.5\n\t\n\tQ_abs = MANTA_Ray.find_Q_abs(wavelength, radius, d_f, n, k) # calculate Q_abs\n \n\tprint(Q_abs)\n \nIf MANTA-Ray installed correctly, you should see:\n\n\tQ_abs = 0.021153387751343056 \n\nTwo functions are provided:\n\n1) find_Q_abs: calculates absorption efficiency $Q_{abs,MR}$ (Eq. 5 in Lodge et al. 2024)\n2) find_C_abs: calculates absorption cross-section (where $C_{abs}=Q_{abs} \\pi R^2$)\n\nBoth functions use the same input variables:\n\n\tQ_abs = MANTA_Ray.find_Q_abs(wavelength, radius, d_f, n, k)\n\tC_abs = MANTA_Ray.find_C_abs(wavelength, radius, d_f, n, k)\n\nIf a pip install fails (or simply if you prefer), you could copy and paste the functions from MANTA_Ray.py directly into your code and use them in the same way.\n\n# The Model\n\nThis section provides a brief overview of the model, but for a full explanation and more details, please read Lodge et al. 2024. \n\nTransmission Electron Microscope (TEM) images of solid matter in Earth's atmosphere shows that they often form very complex shapes, which we call fractal aggregates. Their exact shape depends on the material and conditions under which they form. Typically, we characterise them by a single number -- their fractal dimension $d_f$:\n\n<p align=\"center\">\n <img src=\"https://github.com/user-attachments/assets/7060caea-1465-45dd-9f64-74a351b0733b\" alt=\"drawing\" width=\"400\" />\n</p>\n\nIn the image above the two aggregates are both composed of 24 \"monomers\" (individual spheres), but in different arrangements. These shapes are characterised in many optical models by $d_f$ which is a number between 1 (representing a straight line) and 3 (compact and perfectly spherical).\n\nModelling the optical properties of complex shapes is difficult, and Mie theory is often used (which assumes that the particles are spherical). However, this can often be a significant underestimate of the amount of absorption (by factors of up to 1,000 -- see Lodge et al. 2024). Calculating the optical properties for the true aggregate shape can be done using a rigorous code such as the discrete dipole approximation (DDA -- Draine and Flatau, 1994), but this is usually incredibly time consuming (and unfeasible for use in forward models that wish to study many wavelengths/particle sizes). In contrast, MANTA-Ray estimates absorption cross-sections with average accuracies of 10-20% compared to DDA, but $10^{13}$ times faster. It works for any wavelength, particle size, and refractive index $m$ within 1+0.01i< $m$ <11+11i. It is strictly only for use in the Rayleigh Regime (where the wavelength $\\lambda$ is significantly larger than the radius $R$ of a sphere of equivalent volume to the aggregate -- here we define this regime as $\\lambda \\geq 100R$).\n",
"bugtrack_url": null,
"license": null,
"summary": "MANTA-Ray (Modified Absorption of Non-spherical Tiny Aggregates in the Rayleigh regime) is a model that calculates the absorption efficiency and absorption cross-section of fractal aggregates.",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/mglodge/MANTA-Ray/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a2bb00a6943f02b8ba731257397f188017e4a10982fdb240d3b285f47f48aaad",
"md5": "5e23baf4a7e4c1a626d1c4ef3dffd0da",
"sha256": "6cce4545691ec8199b6140d2d961edee933d3a7c6cd70162013034459369ebac"
},
"downloads": -1,
"filename": "manta_ray_optics-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e23baf4a7e4c1a626d1c4ef3dffd0da",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0.1",
"size": 7266,
"upload_time": "2024-08-21T21:24:11",
"upload_time_iso_8601": "2024-08-21T21:24:11.937701Z",
"url": "https://files.pythonhosted.org/packages/a2/bb/00a6943f02b8ba731257397f188017e4a10982fdb240d3b285f47f48aaad/manta_ray_optics-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e806dd264e89da62c5fab5ac8825e485c67d7bda2922cc90df51a20d6e846480",
"md5": "f1e5293c8d1b772ff14b0413c4f59582",
"sha256": "8a682fae535c99882d8ee5ea6a707dc0429d672e15fced02e90480c101b06441"
},
"downloads": -1,
"filename": "manta_ray_optics-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "f1e5293c8d1b772ff14b0413c4f59582",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0.1",
"size": 5954,
"upload_time": "2024-08-21T21:24:13",
"upload_time_iso_8601": "2024-08-21T21:24:13.319984Z",
"url": "https://files.pythonhosted.org/packages/e8/06/dd264e89da62c5fab5ac8825e485c67d7bda2922cc90df51a20d6e846480/manta_ray_optics-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 21:24:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mglodge",
"github_project": "MANTA-Ray",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "manta-ray-optics"
}
