Skip to content

Simple sunglint computation based on Cox and Munk model

Notifications You must be signed in to change notification settings

Tristanovsk/coxmunk

Repository files navigation

coxmunk

Simple sunglint computation based on Cox & Munk model. For more details on the statistics of the wave slopes (i.e., Probability Distribution Function), please refer to Munk 2009.

image_output

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them

python3 -m pip install --user --upgrade setuptools

Installing

First, clone the repository and execute the following command in the local copy:

python3 setup.py install 

This will install the package into the system's Python path. If you have not the administrator rights, you can install the package as follows:

python3 setup.py install --user

If another destination directory is preferred, it can be set by

python3 setup.py install --prefix=<where-to-install>

This installation is supposed to download and compile all the associated packages as well as prepare the executables coxmunk.

If the installation is successful, you should have:

$ coxmunk
Usage:
  coxmunk <sza> <wind_speed> [--stats <stats>] [--wind_azi <wind_azi>]
  coxmunk -h | --help
  coxmunk -v | --version

Running the tests

Examples for Cox & Munk model with Bréon & Henriot statitics for:

  • solar vieving angle = 39°
  • wind azimuth from Sun = 75°
  • wind speed = 0.2, 7.2, 14.2 m.s-1
$ coxmunk 39 0.2 --stats bh2006 --wind_azi 75 --figname illustration/coxmunk_fig_39_0.2_bh2006_75.png

image_output

$ coxmunk 39 7.2 --stats bh2006 --wind_azi 75

image_output

$ coxmunk 39 14.2 --stats bh2006 --wind_azi 75

image_output

With the option --slope you can also check the values of wave slopes upwind and crosswind, the first term of the Fresnel matrix and the probability distribution function:

$ coxmunk 20 5 --stats bh2006 --wind_azi 60 --slope

image_output

About

Simple sunglint computation based on Cox and Munk model

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published