pyjams: a general Python package with miscellaneous utility functions used in several other packages.
Project description
A general Python package with miscellaneous utility functions used in several other packages.
About pyjams
pyjams is a general Python package offering miscellaneous functions in different categories, such as reading different file formats, Julian date routines, or calculating Elementary Effects. It has several subpackages offering constants or special functions, or objective functions to be used with scipy.optimize.
The package modernises and makes available routines of the JAMS Python library, which was created 2009 by Matthias Cuntz while at the Department of Computational Hydrosystems, Helmholtz Centre for Environmental Research - UFZ, Leipzig, Germany, and continued while at Institut National de Recherche pour l’Agriculture, l’Alimentation et l’Environnement (INRAE), Nancy, France.
The complete documentation of pyjams is available at:
Installation
The easiest way to install is via pip:
pip install pyjams
- Requirements
Content
- Modules and functions are currently provided in the following categories:
Functions and modules (alphabetical)
Function/module |
Short description |
---|---|
closest |
Index in array which entry is closest to a given number. |
const |
Physical, mathematical, computational, isotope, and material constants. |
elementary_effects |
Morris measures mu, stddev and mu* |
functions |
Special functions for testing optimisations, sensitivity analysis, several forms of the logistic function and its derivatives, and other functions to be used with scipy.optimize. |
morris_sampling |
Sampling of optimised trajectories for Morris measures / Elementary Effects |
screening |
Parameter screening using Morris’ method of Elementary Effects. |
tee |
Prints arguments on screen and in file, like Unix/Linux tee utility. |
Functions and modules per category
- Array manipulation
Function/module
Short description
closest
Index in array which entry is closest to a given number.
- Math
Function/module
Short description
elementary_effects
Morris measures mu, stddev and mu*
functions
Special functions for testing optimisations, sensitivity analysis, several forms of the logistic function and its derivatives, and other functions to be used with scipy.optimize.
morris_sampling
Sampling of optimised trajectories for Morris measures / Elementary Effects
screening
Parameter screening using Morris’ method of Elementary Effects.
- Miscellaneous
Function/module
Short description
const
Physical, mathematical, computational, isotope, and material constants.
tee
Prints arguments on screen and in file, like Unix/Linux tee utility.
License
pyjams is distributed under the MIT License. See the LICENSE file for details.
Copyright (c) 2012-2021 Matthias Cuntz, Juliane Mai, Stephan Thober, and Arndt Piayda
The project structure of pyjams has borrowed heavily from welltestpy by Sebastian Müller.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.