[](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/5a/11/4a8fec3aaa1baf49e50c228f4c5ca36c57083a46d0e8969988bc51c50e4b/rms_solar-2.0.3.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.3",
"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": "77775ae8ef4a4ca005f47494e336fa927f84d72ef5a80afb06d12cb2b40c8bcb",
"md5": "54f0ba5101b945e7c9f16a1fbcf5dc46",
"sha256": "705563f32d5b17f3f892df3d3ee954b0133b73c2c6f2e7d54a8e02e9e4fd6fb1"
},
"downloads": -1,
"filename": "rms_solar-2.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "54f0ba5101b945e7c9f16a1fbcf5dc46",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 509056,
"upload_time": "2024-12-16T20:40:04",
"upload_time_iso_8601": "2024-12-16T20:40:04.578463Z",
"url": "https://files.pythonhosted.org/packages/77/77/5ae8ef4a4ca005f47494e336fa927f84d72ef5a80afb06d12cb2b40c8bcb/rms_solar-2.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5a114a8fec3aaa1baf49e50c228f4c5ca36c57083a46d0e8969988bc51c50e4b",
"md5": "851c81ebf4f43e4f17ca0d0b4d078986",
"sha256": "4a33825847ab0584e8bd671b0050b4e1fe26d12a73546b8761fda8f81a5de0b7"
},
"downloads": -1,
"filename": "rms_solar-2.0.3.tar.gz",
"has_sig": false,
"md5_digest": "851c81ebf4f43e4f17ca0d0b4d078986",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 521309,
"upload_time": "2024-12-16T20:40:07",
"upload_time_iso_8601": "2024-12-16T20:40:07.981590Z",
"url": "https://files.pythonhosted.org/packages/5a/11/4a8fec3aaa1baf49e50c228f4c5ca36c57083a46d0e8969988bc51c50e4b/rms_solar-2.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 20:40:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SETI",
"github_project": "rms-solar",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "astropy",
"specs": []
},
{
"name": "coverage",
"specs": []
},
{
"name": "flake8",
"specs": []
},
{
"name": "myst-parser",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "rms-tabulation",
"specs": []
},
{
"name": "sphinx",
"specs": []
},
{
"name": "sphinxcontrib-napoleon",
"specs": []
},
{
"name": "sphinx-rtd-theme",
"specs": []
}
],
"lcname": "rms-solar"
}
JSON
