API Reference#
pyjams is a general Python package with a wide variety of miscellaneous utility functions. It is offering miscellaneous functions in different categories, such as reading different file formats, date conversion routines, or meteorological functions. It has several subpackages offering constants, special functions as well as objective functions to be used with scipy.optimize.fmin or scipy.optimize.curvefit, and much more.
The package has evolved from its predecessor the JAMS Python package mcuntz/jams_python
- copyright:
Copyright 2021-2022 Matthias Cuntz, see AUTHORS.rst for details.
- license:
MIT License, see LICENSE for details.
Subpackages#
Air humidity calculations |
|
|
Isotopic fractionation factors during liquid-water vapour equilibration. |
|
Kinetic fractionation factors for molecular diffusion of water isotopologues. |
|
Wrapper for numpy.argsort, numpy.ma.argsort, and sorted for Python iterables |
|
Area of grid cells on a spherical Earth in square metre |
|
Index in array which entry is closest to a given number. |
Collection of color palettes and continuous color maps |
|
Provides physical, mathematical, computational, isotope, and material constants, such as Pi = 3.141592653589793238462643383279502884197. |
|
|
Convert date representations between different regional variants |
Conversion of datetime formats |
|
|
Divide two arrays, return otherwise if division by 0. |
GUI dialogs to choose files and directories using Tkinter |
|
|
Read numbers and strings from a file into 2D float and string arrays |
Provides a variety of special functions, including common test functions for parameter estimations such as Rosenbrock and Griewank, test functions for parameter sensitivity analysis such as the Ishigami and Homma function, several forms of the logistic function and its first and second derivatives, and a variety of other functions together with robust and square cost functions to use with the |
|
JAMS Python Utilities |
|
|
Multi-dimensional non-parametric kernel regression |
|
Median absolute deviation test |
Standard plotting class of Matthias Cuntz. |
|
|
Calculate daily, monthly, yearly, etc. |
Morris' Method of Elementary Effects. |
|
|
Get information on variables in a netcdf file |
netCDF4 functions to copy a netcdf file while doing some transformations on variables and dimensions. |
|
|
Gets variables of a netcdf file |
Update arrays in a single file in numpy's npz format |
|
|
Mimics Fortran intrinsic pack (without optional vector) |
|
Gives positions of subplots, to be used with add_axes instead of subplot |
Convert integer to and from Roman numerals |
|
|
Shuffled Complex Evolution algorithm for finding the minimum of a multivariate function |
|
Parameter screening using Morris' method of Elementary Effects. |
|
Convert strings to LaTeX strings in math environment used by matplotlib's usetex |
|
Prints arguments on screen and in file, like Unix/Linux tee utility. |
|
Write text on plot |
- History
Written Oct 2021 by Matthias Cuntz (mc (at) macu (dot) de)
v1.0, initial Github, PyPI, Zenodo commit, Oct 2021, Matthias Cuntz
v1.1, automatic versioning, zenodo defaults, Oct 2021, Matthias Cuntz
v1.2, added closest, Oct 2021, Matthias Cuntz
v1.3, added argsort, Oct 2021, Matthias Cuntz
v1.4, added division, Oct 2021, Matthias Cuntz
v1.5, added alpha_equ_h2o, Oct 2021, Matthias Cuntz
v1.6, added alpha_kin_h2o, Nov 2021, Matthias Cuntz
v1.7, added mcPlot, Nov 2021, Matthias Cuntz
v1.8, added str2tex and color, Nov 2021, Matthias Cuntz
v1.9, added position, Nov 2021, Matthias Cuntz
v1.10, added sron colors, Nov 2021, Matthias Cuntz
v1.11, added text2plot, abc2plot, signature2plot, Nov 2021, Matthias Cuntz
v1.12, added date2dec and all its wrappers, Dec 2021, Matthias Cuntz
v1.13, added fsread, fread, sread, Dec 2021, Matthias Cuntz
v1.14, added GUI dialogs to choose files and directories using Tkinter, Jan 2022, Matthias Cuntz
v1.15, added esat, Jan 2022, Matthias Cuntz
v1.16, added mad, Jan 2022, Matthias Cuntz
v1.17, added xread, xlsread, and xlsxread, Jan 2022, Matthias Cuntz
v1.18, helper module to preserve input types, Mar 2022, Matthias Cuntz
v1.19, added readnetcdf, Mar 2022, Matthias Cuntz
v1.20, added gridcellarea and kernel_regression, Apr 2022, Matthias Cuntz
v1.21, enhancements in color and kernel_regression, Apr 2022, Matthias Cuntz
v1.22, added ncio, May 2022, Matthias Cuntz
v1.23, added datetime module, Jun 2022, Matthias Cuntz
v1.24, moved docu to Github Pages, Jun 2022, Matthias Cuntz
v1.25, Microseconds and negative years in date2date and datetime, Jun 2022, Matthias Cuntz
v1.26, added means, Jul 2022, Matthias Cuntz
v1.27, added sce, Dec 2022, Matthias Cuntz
v1.28, added updatez, Jan 2023, Matthias Cuntz
v1.29, added functions for converting humidity in air, Jan 2023, Matthias Cuntz
v1.30, hvplot in mcplot, May 2023, Matthias Cuntz
v1.31, added pack and unpack, Jun 2023, Matthias Cuntz
v1.32, added jams, Jun 2023, Matthias Cuntz
v1.33, start supporting pandas Series and DataFrames, Jul 2023, Matthias Cuntz
v2.0, full pandas support, Sep 2023, Matthias Cuntz
v2.1, ncread and ncinfo in individual files, Nov 2023, Matthias Cuntz
v2.2, enhancements of plotting routines, ncio, fsread, and datetime, Aug 2024, Matthias Cuntz