| Name | rms-solar JSON |
| Version |
2.0.2
JSON |
| download |
| home_page | None |
| Summary | Models for solar flux density at 1 AU |
| upload_time | 2024-09-30 23:58:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
solar
flux
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
[](https://github.com/SETI/rms-solar/releases)
[](https://github.com/SETI/rms-solar/releases)
[](https://github.com/SETI/rms-solar/actions)
[](https://rms-solar.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/SETI/rms-solar)
<br />
[](https://pypi.org/project/rms-solar)
[](https://pypi.org/project/rms-solar)
[](https://pypi.org/project/rms-solar)
[](https://pypi.org/project/rms-solar)
<br />
[](https://github.com/SETI/rms-solar/commits/main/)
[](https://github.com/SETI/rms-solar/commits/main/)
[](https://github.com/SETI/rms-solar/commits/main/)
<br />
[](https://github.com/SETI/rms-solar/issues)
[](https://github.com/SETI/rms-solar/issues)
[](https://github.com/SETI/rms-solar/pulls)
[](https://github.com/SETI/rms-solar/pulls)
<br />
[](https://github.com/SETI/rms-solar/stargazers)
# Introduction
`solar` is a Python module that provides solar flux density from a variety of
models. These models are currently supported:
| Name | Wavelength range (microns) |
| ---------- | -------------------------- |
| Colina | 0.1195 to 2.5 |
| Kurucz | 0.15 to 300 |
| Rieke | 0.2 to 30 |
| STIS | 0.1195 to 2.7 |
| STIS_Rieke | 0.1195 to 30 |
`solar` is a product of the [PDS Ring-Moon Systems Node](https://pds-rings.seti.org).
# Installation
The `solar` module is available via the `rms-solar` package on PyPI and can be
installed with:
```sh
pip install rms-solar
```
# Getting Started
The `solar` module provides five functions:
- [`flux_density`](https://rms-solar.readthedocs.io/en/latest/module.html#solar.flux_density):
Compute the flux density of a solar model in the specified units.
- [`bandpass_flux_density`](https://rms-solar.readthedocs.io/en/latest/module.html#solar.bandpass_flux_density):
Compute the average solar flux density over a filter bandpass.
- [`mean_flux_density`](https://rms-solar.readthedocs.io/en/latest/module.html#solar.mean_flux_density):
Compute average solar flux density over the bandpass of a "boxcar" filter.
- [`bandpass_f`](https://rms-solar.readthedocs.io/en/latest/module.html#solar.bandpass_f):
Compute the solar F averaged over a filter bandpass.
- [`mean_f`](https://rms-solar.readthedocs.io/en/latest/module.html#solar.mean_f):
Compute average solar F over the bandpass of a "boxcar" filter.
These functions take or return `Tabulation` objects. For more information on `Tabulation`
objects see the [`rms-tabulation`](https://github.com/SETI/rms-tabulation) package.
Details of each function are available in the [module documentation](https://rms-solar.readthedocs.io/en/latest/module.html).
Here is an example that plots the solar flux density for the visual range of 400
to 700 nm using the Rieke model at 2 AU in units of nm for wavelength and
W/m^2/nm for flux:
```python
import matplotlib.pyplot as plt
import solar
flux = solar.flux_density(model='rieke', xunits='nm', units='W/m^2/nm', solar_range=2)
flux = flux.clip(400, 700)
plt.plot(flux.x, flux.y)
plt.show()
```
# Contributing
Information on contributing to this package can be found in the
[Contributing Guide](https://github.com/SETI/rms-solar/blob/main/CONTRIBUTING.md).
# Links
- [Documentation](https://rms-solar.readthedocs.io)
- [Repository](https://github.com/SETI/rms-solar)
- [Issue tracker](https://github.com/SETI/rms-solar/issues)
- [PyPi](https://pypi.org/project/rms-solar)
# Licensing
This code is licensed under the [Apache License v2.0](https://github.com/SETI/rms-solar/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "rms-solar",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "\"Robert S. French\" <rfrench@seti.org>",
"keywords": "solar, flux",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a0/c6/fbcf4ca6dc4733302589a74991dad8b7b4237d9d0f1fe7ffd8072a355b5c/rms_solar-2.0.2.tar.gz",
"platform": null,
"description": "[](https://github.com/SETI/rms-solar/releases)\n[](https://github.com/SETI/rms-solar/releases)\n[](https://github.com/SETI/rms-solar/actions)\n[](https://rms-solar.readthedocs.io/en/latest/?badge=latest)\n[](https://codecov.io/gh/SETI/rms-solar)\n<br />\n[](https://pypi.org/project/rms-solar)\n[](https://pypi.org/project/rms-solar)\n[](https://pypi.org/project/rms-solar)\n[](https://pypi.org/project/rms-solar)\n<br />\n[](https://github.com/SETI/rms-solar/commits/main/)\n[](https://github.com/SETI/rms-solar/commits/main/)\n[](https://github.com/SETI/rms-solar/commits/main/)\n<br />\n[](https://github.com/SETI/rms-solar/issues)\n[](https://github.com/SETI/rms-solar/issues)\n[](https://github.com/SETI/rms-solar/pulls)\n[](https://github.com/SETI/rms-solar/pulls)\n<br />\n\n[](https://github.com/SETI/rms-solar/stargazers)\n\n\n# Introduction\n\n`solar` is a Python module that provides solar flux density from a variety of\nmodels. These models are currently supported:\n\n| Name | Wavelength range (microns) |\n| ---------- | -------------------------- |\n| Colina | 0.1195 to 2.5 |\n| Kurucz | 0.15 to 300 |\n| Rieke | 0.2 to 30 |\n| STIS | 0.1195 to 2.7 |\n| STIS_Rieke | 0.1195 to 30 |\n\n`solar` is a product of the [PDS Ring-Moon Systems Node](https://pds-rings.seti.org).\n\n# Installation\n\nThe `solar` module is available via the `rms-solar` package on PyPI and can be\ninstalled with:\n\n```sh\npip install rms-solar\n```\n\n# Getting Started\n\nThe `solar` module provides five functions:\n\n- [`flux_density`](https://rms-solar.readthedocs.io/en/latest/module.html#solar.flux_density):\n Compute the flux density of a solar model in the specified units.\n- [`bandpass_flux_density`](https://rms-solar.readthedocs.io/en/latest/module.html#solar.bandpass_flux_density):\n Compute the average solar flux density over a filter bandpass.\n- [`mean_flux_density`](https://rms-solar.readthedocs.io/en/latest/module.html#solar.mean_flux_density):\n Compute average solar flux density over the bandpass of a \"boxcar\" filter.\n- [`bandpass_f`](https://rms-solar.readthedocs.io/en/latest/module.html#solar.bandpass_f):\n Compute the solar F averaged over a filter bandpass.\n- [`mean_f`](https://rms-solar.readthedocs.io/en/latest/module.html#solar.mean_f):\n Compute average solar F over the bandpass of a \"boxcar\" filter.\n\nThese functions take or return `Tabulation` objects. For more information on `Tabulation`\nobjects see the [`rms-tabulation`](https://github.com/SETI/rms-tabulation) package.\n\nDetails of each function are available in the [module documentation](https://rms-solar.readthedocs.io/en/latest/module.html).\n\nHere is an example that plots the solar flux density for the visual range of 400\nto 700 nm using the Rieke model at 2 AU in units of nm for wavelength and\nW/m^2/nm for flux:\n\n```python\nimport matplotlib.pyplot as plt\nimport solar\n\nflux = solar.flux_density(model='rieke', xunits='nm', units='W/m^2/nm', solar_range=2)\nflux = flux.clip(400, 700)\nplt.plot(flux.x, flux.y)\nplt.show()\n```\n\n# Contributing\n\nInformation on contributing to this package can be found in the\n[Contributing Guide](https://github.com/SETI/rms-solar/blob/main/CONTRIBUTING.md).\n\n# Links\n\n- [Documentation](https://rms-solar.readthedocs.io)\n- [Repository](https://github.com/SETI/rms-solar)\n- [Issue tracker](https://github.com/SETI/rms-solar/issues)\n- [PyPi](https://pypi.org/project/rms-solar)\n\n# Licensing\n\nThis code is licensed under the [Apache License v2.0](https://github.com/SETI/rms-solar/blob/main/LICENSE).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Models for solar flux density at 1 AU",
"version": "2.0.2",
"project_urls": {
"Documentation": "https://rms-solar.readthedocs.io/en/latest",
"Homepage": "https://github.com/SETI/rms-solar",
"Issues": "https://github.com/SETI/rms-solar/issues",
"Repository": "https://github.com/SETI/rms-solar",
"Source": "https://github.com/SETI/rms-solar"
},
"split_keywords": [
"solar",
" flux"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "40f0e1d977cbdb168b621a123ddffb6f365cfb5f10a3786c2f7b671147b12026",
"md5": "1c4248bd43a7453205c1a63351fe0691",
"sha256": "f4dcd56fc80cca3d78b07efff3e2fdd5d8848dcf1f44de6ba2f816b405e7bfdc"
},
"downloads": -1,
"filename": "rms_solar-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c4248bd43a7453205c1a63351fe0691",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 509053,
"upload_time": "2024-09-30T23:58:48",
"upload_time_iso_8601": "2024-09-30T23:58:48.894913Z",
"url": "https://files.pythonhosted.org/packages/40/f0/e1d977cbdb168b621a123ddffb6f365cfb5f10a3786c2f7b671147b12026/rms_solar-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a0c6fbcf4ca6dc4733302589a74991dad8b7b4237d9d0f1fe7ffd8072a355b5c",
"md5": "88b1a56d24b7f53f923b77bddd2dcefd",
"sha256": "2317fc5f15eeb54ac62d56bdbe69d8e964663a9daefef714986930cd76a0dd45"
},
"downloads": -1,
"filename": "rms_solar-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "88b1a56d24b7f53f923b77bddd2dcefd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 521322,
"upload_time": "2024-09-30T23:58:50",
"upload_time_iso_8601": "2024-09-30T23:58:50.559238Z",
"url": "https://files.pythonhosted.org/packages/a0/c6/fbcf4ca6dc4733302589a74991dad8b7b4237d9d0f1fe7ffd8072a355b5c/rms_solar-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-30 23:58:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SETI",
"github_project": "rms-solar",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "rms-solar"
}
