Skip to main content

Models for solar flux density at 1 AU

Project description

GitHub release; latest by date GitHub Release Date Test Status Documentation Status Code coverage
PyPI - Version PyPI - Format PyPI - Downloads PyPI - Python Version
GitHub commits since latest release GitHub commit activity GitHub last commit
Number of GitHub open issues Number of GitHub closed issues Number of GitHub open pull requests Number of GitHub closed pull requests
GitHub License Number of GitHub stars GitHub forks

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.

Installation

The solar module is available via the rms-solar package on PyPI and can be installed with:

pip install rms-solar

Getting Started

The solar module provides five functions:

  • flux_density: Compute the flux density of a solar model in the specified units.
  • bandpass_flux_density: Compute the average solar flux density over a filter bandpass.
  • mean_flux_density: Compute average solar flux density over the bandpass of a "boxcar" filter.
  • bandpass_f: Compute the solar F averaged over a filter bandpass.
  • 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 package.

Details of each function are available in the module documentation.

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:

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.

Links

Licensing

This code is licensed under the Apache License v2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rms_solar-2.0.3.tar.gz (521.3 kB view details)

Uploaded Source

Built Distribution

rms_solar-2.0.3-py3-none-any.whl (509.1 kB view details)

Uploaded Python 3

File details

Details for the file rms_solar-2.0.3.tar.gz.

File metadata

  • Download URL: rms_solar-2.0.3.tar.gz
  • Upload date:
  • Size: 521.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for rms_solar-2.0.3.tar.gz
Algorithm Hash digest
SHA256 4a33825847ab0584e8bd671b0050b4e1fe26d12a73546b8761fda8f81a5de0b7
MD5 851c81ebf4f43e4f17ca0d0b4d078986
BLAKE2b-256 5a114a8fec3aaa1baf49e50c228f4c5ca36c57083a46d0e8969988bc51c50e4b

See more details on using hashes here.

File details

Details for the file rms_solar-2.0.3-py3-none-any.whl.

File metadata

  • Download URL: rms_solar-2.0.3-py3-none-any.whl
  • Upload date:
  • Size: 509.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for rms_solar-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 705563f32d5b17f3f892df3d3ee954b0133b73c2c6f2e7d54a8e02e9e4fd6fb1
MD5 54f0ba5101b945e7c9f16a1fbcf5dc46
BLAKE2b-256 77775ae8ef4a4ca005f47494e336fa927f84d72ef5a80afb06d12cb2b40c8bcb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page