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
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
Built Distribution
File details
Details for the file lutzpocflux-0.1.4.tar.gz
.
File metadata
- Download URL: lutzpocflux-0.1.4.tar.gz
- Upload date:
- Size: 3.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.3 Windows/10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26e34e411826fa321962faa4d6757920c0b47b267e7a72aa33505b4d73d77596 |
|
MD5 | 1a874e3179ff5d0b60e67efe318cdc89 |
|
BLAKE2b-256 | 212e4fce401931bde28cf32850265672a11e25929827351246370ae98abe67a9 |
File details
Details for the file lutzpocflux-0.1.4-py3-none-any.whl
.
File metadata
- Download URL: lutzpocflux-0.1.4-py3-none-any.whl
- Upload date:
- Size: 3.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.3 Windows/10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f5be9371f9466dc43989bef97b3d3f1b530ce81312bf50593d6bfca78623509 |
|
MD5 | 2572a69a7f62e4f60ad3458732c64877 |
|
BLAKE2b-256 | 3c88d3fdb193e8951c6b11b2f8bf8a414b6ff77a54c5b84ef064b57c085940a7 |