Skip to content

SETI/rms-solar

Repository files navigation

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.