Skip to main content

Calculate POC Export flux, as Lutz et al. 2007

Project description

Lutz POC FLux

LutzPOCFlux is a Python library for calculating POC export flux as detailed in Lutz et al. 2007.

Installation

Use the package manager pip to install LutzPOCFlux.

pip install lutzpocflux

Numpy is the only dependency. Other parts of the process, such as reading HDF files and plotting results are expected to be done with other packages.

Usage

There is a convenience class for calculating Flux given a list of annual npp arrays and a ze array (or float value).

This handles

  • Creation of the SVI array
  • Creation of the total average array
  • Calculation of the p ratio_ze
  • Application of the ratio to the total average array
from lutzpocflux import MakeFlux
mf = MakeFlux(ze=ze, annual_npp=npp_list)
flux = mf.get_flux()

Alternatively the calculated flux ratio can be used against another npp array provided seperately.

from lutzpocflux import MakeFlux
mf = MakeFlux(ze=4000.0, annual_npp=npp_list, npp=some_other_npp)
flux = mf.get_flux()

Or the equations can be used on their own.

from lutzpocflux.equations import (
    prd_f,
    rld_f,
    prr_f,
    pratioze_f,
)

# Assuming you already have an average npp and SVI layer, you can
# calculate individual parameters
rld = rld_f(svi)
prd = prd_f(svi)
prr = prr_f(svi)

# ze can be a 2D array of the same shape as the npp input arrays or a float value
pratio = pratioze_f(prd,ze,rld,prr)

# Now use the pratio to calculate your export npp given your choice of npp array:
npp_flux = npp * pratio

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Acknowledgments

Results were tested agains the R package here

License

MIT

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

lutzpocflux-0.1.3.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

lutzpocflux-0.1.3-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file lutzpocflux-0.1.3.tar.gz.

File metadata

  • Download URL: lutzpocflux-0.1.3.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Windows/10

File hashes

Hashes for lutzpocflux-0.1.3.tar.gz
Algorithm Hash digest
SHA256 c132310e4480d79c0c268e04762038f9f53ca2c516d7fc2ab3b534ad42dbfc4b
MD5 d96c341ba59b94b1c67b9e7c62c32e3d
BLAKE2b-256 cb5e65aa6374bebecfdeca6ebd93debfa92d20de274281b0d99d1e8303dfc9dd

See more details on using hashes here.

File details

Details for the file lutzpocflux-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: lutzpocflux-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Windows/10

File hashes

Hashes for lutzpocflux-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 37766ffb385ad05c8960201a5d1f86a9f56ca3a1208e6e9097cd4907e728e04a
MD5 55ade65d46fce7a7dad1c99644d99f6d
BLAKE2b-256 a3a27e5bcc7f9ad5a9d681d0c07b265b0ba8d53eba235bc0e24c1879c584d6e6

See more details on using hashes here.

Supported by

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