A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

pyOSOAA

A python interface for the Ocean Successive Orders with Atmosphere radiative transfer.
https://github.com/fnemina/pyosoaa

Category: Atmosphere
Sub Category: Radiative Transfer

Keywords

atmospheric-science ocean-sciences radiative-transfer radiative-transfer-models

Last synced: about 12 hours ago
JSON representation

Repository metadata

pyOSOAA is a python interface for the Ocean Successive Orders with Atmosphere - Advanced (OSOAA) radiative transfer.

README.md

Build Status Coverage Status

pyOSOAA

pyOSOAA is a python interface for the Ocean Successive Orders with Atmosphere - Advanced (OSOAA) radiative transfer. The OSOAA is a radiative transfer code developed in the Sorbonne Université by Pr. Malik Chami group and supported by the CNES.

The coded is based in the successive orders of scattering method and the OSOA code developed by Malik Chami in 2001 that included the computation of the radiance and polarization for the ocean-atmosphere system with a flat surface.

The OSOAA code simulates:

  • Atmospheric and sea profiles: The atmosphere can be and sea profiles can be defined by the user both for the molecules and aerosol in the atmosphere and the water column, chlorophyll and mineral-like particles in the sea. Detritus and yellow substance absorption can also be modelled.
  • Aerosol models: Aerosol models include WMO, LND, Junge mono-modal, bimodal LND and Shettle and Fenn.
  • Hydrosol models: For phytoplankton and mineral-like particles including scattering and absorbing properties.
  • Sea surface interface: Both for a flat surface or by a rough surface using Cox and Munk model.

The pyOSOAA interface aims to incorporate the creation of run scripts and parsing of output results for the OSOAA model. It also incorporates helpers to perform common tasks like calculating the radiance for a certain band instead of a wavelength or running the model for multiple wavelengths.

This code was inspired by py6S by Robin Wilson.

You can find the full pyOSOAA manual here.

Installation

The installation of the pyOSOAA has two parts.

First, you need to install the OSOAA software package from https://github.com/CNES/RadiativeTransferCode-OSOAA.

Second, install pyOSOAA. There are two ways to install pyOSOAA.

Install pyOSOAA from pypi

pip install pyOSOAA

Install pyOSOAA from source code

Download the last version of the pyOSOAA from github.

Once downloaded decompress it, go to the folder containing the code and run

python setup.py install

To then check that software installed correctly

# Load pyOSOAA module
import pyOSOAA
# Run the test suite
pyOSOAA.test()

the following output should appear at the end of the screen

OSOAA wrapper script by Francisco Nemiña
Inspired by Py6S wrapper by Robin Wilson
Using OSOAA located at /home/.../OSOAA_V1.5
Running OSOAA using a set of test parameters
The results are:
Expected result: 0.128266
Actual result: 0.128266
#### Results agree PyOSOAA is working correctly

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 170
Total Committers: 5
Avg Commits per committer: 34.0
Development Distribution Score (DDS): 0.082

Commits in past year: 5
Committers in past year: 3
Avg Commits per committer in past year: 1.667
Development Distribution Score (DDS) in past year: 0.6

Name Email Commits
Francisco Nemiña f****a@g****m 156
XQiao 1****7@q****m 10
fengqiaogh q****g@s****n 2
fengqiao f****c@o****m 1
fengqiaogh 1****h 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 41
Total pull requests: 16
Average time to close issues: 22 days
Average time to close pull requests: 5 days
Total issue authors: 14
Total pull request authors: 3
Average comments per issue: 1.41
Average comments per pull request: 0.19
Merged pull request: 14
Bot issues: 0
Bot pull requests: 0

Past year issues: 2
Past year pull requests: 2
Past year average time to close issues: N/A
Past year average time to close pull requests: 1 minute
Past year issue authors: 2
Past year pull request authors: 1
Past year average comments per issue: 2.5
Past year average comments per pull request: 0.0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/fnemina/pyosoaa

Top Issue Authors

  • fnemina (22)
  • fengqiaogit (5)
  • Tianfeng-Pink (3)
  • wanghuajing271413 (1)
  • binbinjiang1990 (1)
  • lwk1542 (1)
  • fserva (1)
  • panyuwei1 (1)
  • CDesj (1)
  • ruohu129 (1)
  • amsuhail (1)
  • ashishbijlani (1)
  • xueyi991010 (1)
  • yichen-li2016 (1)

Top Pull Request Authors

  • fengqiaogit (9)
  • fnemina (4)
  • fengqiaogh (3)

Top Issue Labels

  • enhancement (6)
  • good first issue (3)
  • bug (1)

Top Pull Request Labels


Package metadata

pypi.org: pyosoaa

pyOSOAA is a python interface for the Ocean Successive Orders with Atmosphere - Advanced (OSOAA) radiative transfer.

  • Homepage: https://github.com/fnemina/pyOSOAA
  • Documentation: https://pyosoaa.readthedocs.io/
  • Licenses: GPL-3.0
  • Latest release: 1.5 (published over 2 years ago)
  • Last Synced: 2025-04-20T11:01:52.516Z (7 days ago)
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 26 Last month
  • Rankings:
    • Dependent packages count: 7.306%
    • Forks count: 14.272%
    • Stargazers count: 14.874%
    • Average: 21.841%
    • Dependent repos count: 22.077%
    • Downloads: 50.676%
  • Maintainers (2)

Dependencies

pyproject.toml pypi
setup.py pypi

Score: 8.690305809124883