Skip to content

Commit

Permalink
Changed to sphinx_book_theme for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mcuntz committed Nov 18, 2023
1 parent 3ac5904 commit 7bc56f4
Show file tree
Hide file tree
Showing 257 changed files with 53,512 additions and 10,982 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
Changelog
---------

v2.1 (??? 2023)
v2.1 (Nov 2023)
* Changed to sphinx_book_theme for documentation.
* Correct all tests.
* Check if outin is Iterable even if inp is not in `array2input`.
* Split ncread and ncinfo in individual files.
* Rename readnetcdf file to ncread.
* Check if scalar is number in array2input.
Expand Down
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 86fdf8fa392b9ead894b7aaabea012aa
config: 6c1d106b423113e7195f69db541363fe
tags: 645f666f9bcd5a90fca523b33c5a78b7
486 changes: 412 additions & 74 deletions docs/html/_modules/index.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/air_humidity.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/alpha_equ_h2o.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/alpha_kin_h2o.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/argsort.html

Large diffs are not rendered by default.

495 changes: 415 additions & 80 deletions docs/html/_modules/pyjams/class_datetime.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/closest.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/color/color.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/date2date.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/division.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/fgui.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/fsread.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/functions/fit_functions.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/functions/general_functions.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/functions/logistic_function.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/functions/opti_test_functions.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/functions/sa_test_functions.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/gridcellarea.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/kernel_regression.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/mad.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/mcplot.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/means.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/morris_method.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/ncinfo.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/ncio/netcdfio.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/ncread.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/npyio.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/pack.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/position.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/romanliterals.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/sce.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/screening.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/str2tex.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/tee.html

Large diffs are not rendered by default.

488 changes: 412 additions & 76 deletions docs/html/_modules/pyjams/text2plot.html

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
90 changes: 45 additions & 45 deletions docs/html/_sources/index.rst.txt → docs/html/_sources/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ Functions and modules (alphabetical)
- Short description
* - :func:`~pyjams.text2plot.abc2plot`
- Write a, B, iii), ... on a plot
* - :func:`~pyjams.alpha_equ_h2o`
* - :func:`~pyjams.alpha_equ_h2o.alpha_equ_h2o`
- Equilibrium fractionation between liquid water and vapour
* - :func:`~pyjams.alpha_kin_h2o`
* - :func:`~pyjams.alpha_kin_h2o.alpha_kin_h2o`
- Kinetic fractionation of molecular diffusion of water vapour
* - :func:`~pyjams.argsort.argmax`
- Wrapper for numpy.argmax, numpy.ma.argmax, and max for Python
Expand All @@ -113,7 +113,7 @@ Functions and modules (alphabetical)
* - :func:`~pyjams.argsort.argsort`
- Wrapper for numpy.argsort, numpy.ma.argsort, and sorted for Python
iterables
* - :func:`~pyjams.closest`
* - :func:`~pyjams.closest.closest`
- Index in array which entry is closest to a given number
* - :mod:`~pyjams.color`
- Collection of color palettes and continuous color maps
Expand Down Expand Up @@ -145,13 +145,13 @@ Functions and modules (alphabetical)
* - :func:`~pyjams.division.div`
- Divide two arrays, return 'otherwise' if division by 0,
same as `division`
* - :func:`~pyjams.eair2mrair`
* - :func:`~pyjams.air_humidity.eair2mrair`
- Mixing ratio from partial pressure of water vapour and total pressure
* - :func:`~pyjams.eair2rhair`
* - :func:`~pyjams.air_humidity.eair2rhair`
- Relative humidity from partial pressure of water vapour and temperature
* - :func:`~pyjams.eair2shair`
* - :func:`~pyjams.air_humidity.eair2shair`
- Specific humidity from partial pressure of water vapour and total pressure
* - :func:`~pyjams.eair2vpd`
* - :func:`~pyjams.air_humidity.eair2vpd`
- Air vapour pressure deficit from partial pressure and temperature
* - :func:`~pyjams.screening.ee`
- Parameter screening using Morris' method of Elementary Effects,
Expand All @@ -164,7 +164,7 @@ Functions and modules (alphabetical)
- Convert dates to French date format DD/MM/YYYY hh:mm:ss
* - :func:`~pyjams.date2date.en2us`
- Convert dates to American date format MM/DD/YYYY hh:mm:ss
* - :func:`~pyjams.esat`
* - :func:`~pyjams.air_humidity.esat`
- Saturation vapour pressure over water and ice
* - :func:`~pyjams.date2date.fr2date`
- Convert French dates to standard date format DD.MM.YYYY hh:mm:ss
Expand All @@ -184,26 +184,26 @@ Functions and modules (alphabetical)
- Special functions for testing optimisations, sensitivity analysis,
several forms of the logistic function and its derivatives, and other
functions to be used with :mod:`scipy.optimize`
* - :func:`~pyjams.gridcellarea`
* - :func:`~pyjams.gridcellarea.gridcellarea`
- Area of grid cells on Earth
* - :func:`~pyjams.ncinfo.infonetcdf`
- Extract information from netCDF file, same as :func:`ncinfo`
* - :func:`~pyjams.romanliterals.int2roman`
- Integer to Roman numeral conversion
* - :func:`~pyjams.kernel_regression`
* - :func:`~pyjams.kernel_regression.kernel_regression`
- Multi-dimensional non-parametric kernel regression
* - :func:`~pyjams.kernel_regression_h`
* - :func:`~pyjams.kernel_regression.kernel_regression_h`
- Determination of bandwidth for kernel regression
* - :func:`~pyjams.mad`
* - :func:`~pyjams.mad.mad`
- Median absolute deviation test
* - :class:`~pyjams.mcplot.mcPlot`
- Matthias Cuntz' standard plotting class
* - :func:`~pyjams.means`
* - :func:`~pyjams.means.means`
- Calculate daily, monthly, yearly, etc. means of data
* - :func:`~pyjams.morris_method.morris_sampling`
- Sampling of optimised trajectories for Morris measures / Elementary
Effects
* - :func:`~pyjams.mrair2eair`
* - :func:`~pyjams.air_humidity.mrair2eair`
- Partial pressure of water vapour from mixing ratio and total pressure
* - :func:`~pyjams.ncinfo.ncinfo`
- Extract information from netCDF file
Expand All @@ -216,30 +216,30 @@ Functions and modules (alphabetical)
- Return datetime objects given numeric time values
* - :func:`~pyjams.pack.pack`
- Pack array with mask like Fortran intrinsic pack
* - :func:`~pyjams.position`
* - :func:`~pyjams.position.position`
- Position arrays of subplots to be used with add_axes
* - :func:`~pyjams.ncread.readnetcdf`
- Read variables from netCDF file, same as `ncread`
* - :func:`~pyjams.rhair2eair`
* - :func:`~pyjams.air_humidity.rhair2eair`
- Partial pressure of water vapour from relative humidity and temperature
* - :func:`~pyjams.rhair2vpd`
* - :func:`~pyjams.air_humidity.rhair2vpd`
- Air vapour pressure deficit from relative humidity and temperature
* - :func:`~pyjams.romanliterals.roman2int`
- Roman numeral to integer conversion
* - :func:`~pyjams.sce.sce`
- Shuffled-Complex-Evolution algorithm for function min(max)imisation
* - :func:`~pyjams.screening.screening`
- Parameter screening using Morris' method of Elementary Effects
* - :func:`~pyjams.shair2eair`
* - :func:`~pyjams.air_humidity.shair2eair`
- Partial pressure of water vapour from specific humidity and total pressure
* - :func:`~pyjams.text2plot.signature2plot`
- Write a copyright notice on a plot
* - :func:`~pyjams.fsread.sread`
- Read strings from a file into 2D string array
* - :func:`~pyjams.str2tex`
* - :func:`~pyjams.str2tex.str2tex`
- Convert strings to LaTeX strings in math environment used by matplotlib's
usetex
* - :func:`~pyjams.tee`
* - :func:`~pyjams.tee.tee`
- Prints arguments on screen and in file, like Unix/Linux tee utility
* - :func:`~pyjams.text2plot.text2plot`
- Write text on a plot
Expand All @@ -255,9 +255,9 @@ Functions and modules (alphabetical)
- Convert dates to English date format YYYY-MM-DD hh:mm:ss
* - :func:`~pyjams.date2date.us2fr`
- Convert dates to French date format DD/MM/YYYY hh:mm:ss
* - :func:`~pyjams.vpd2eair`
* - :func:`~pyjams.air_humidity.vpd2eair`
- Partial pressure of water vapour from air vapour pressure deficit and temperature
* - :func:`~pyjams.vpd2rhair`
* - :func:`~pyjams.air_humidity.vpd2rhair`
- Relative humidity from air vapour pressure deficit and temperature
* - :func:`~pyjams.fsread.xlsread`
- Read numbers and strings from Excel file into 2D float and string arrays,
Expand Down Expand Up @@ -289,7 +289,7 @@ Functions and modules per category
* - :func:`~pyjams.argsort.argsort`
- Wrapper for numpy.argsort, numpy.ma.argsort, and sorted for
Python iterables
* - :func:`~pyjams.closest`
* - :func:`~pyjams.closest.closest`
- Index in array which entry is closest to a given number
* - :func:`~pyjams.pack.pack`
- Pack array with mask like Fortran intrinsic pack
Expand Down Expand Up @@ -321,13 +321,13 @@ Functions and modules per category

* - Function/module
- Short description
* - :func:`~pyjams.kernel_regression`
* - :func:`~pyjams.kernel_regression.kernel_regression`
- Multi-dimensional non-parametric kernel regression
* - :func:`~pyjams.kernel_regression_h`
* - :func:`~pyjams.kernel_regression.kernel_regression_h`
- Determination of bandwidth for kernel regression
* - :func:`~pyjams.mad`
* - :func:`~pyjams.mad.mad`
- Median absolute deviation test
* - :func:`~pyjams.means`
* - :func:`~pyjams.means.means`
- Calculate daily, monthly, yearly, etc. means of data

.. _Date and Time:
Expand Down Expand Up @@ -387,7 +387,7 @@ Functions and modules per category

* - Function/module
- Short description
* - :func:`~pyjams.gridcellarea`
* - :func:`~pyjams.gridcellarea.gridcellarea`
- Area of grid cells on Earth

.. _Isotopes:
Expand All @@ -399,9 +399,9 @@ Functions and modules per category

* - Function/module
- Short description
* - :func:`~pyjams.alpha_equ_h2o`
* - :func:`~pyjams.alpha_equ_h2o.alpha_equ_h2o`
- Equilibrium fractionation between liquid water and vapour
* - :func:`~pyjams.alpha_kin_h2o`
* - :func:`~pyjams.alpha_kin_h2o.alpha_kin_h2o`
- Kinetic fractionation of molecular diffusion of water vapour

.. _Math:
Expand Down Expand Up @@ -444,27 +444,27 @@ Functions and modules per category

* - Function/module
- Short description
* - :func:`~pyjams.eair2mrair`
* - :func:`~pyjams.air_humidity.eair2mrair`
- Mixing ratio from partial pressure of water vapour and total pressure
* - :func:`~pyjams.eair2rhair`
* - :func:`~pyjams.air_humidity.eair2rhair`
- Relative humidity from partial pressure of water vapour and temperature
* - :func:`~pyjams.eair2shair`
* - :func:`~pyjams.air_humidity.eair2shair`
- Specific humidity from partial pressure of water vapour and total pressure
* - :func:`~pyjams.eair2vpd`
* - :func:`~pyjams.air_humidity.eair2vpd`
- Air vapour pressure deficit from partial pressure and temperature
* - :func:`~pyjams.esat`
* - :func:`~pyjams.air_humidity.esat`
- Saturation vapour pressure over water and ice
* - :func:`~pyjams.mrair2eair`
* - :func:`~pyjams.air_humidity.mrair2eair`
- Partial pressure of water vapour from mixing ratio and total pressure
* - :func:`~pyjams.rhair2eair`
* - :func:`~pyjams.air_humidity.rhair2eair`
- Partial pressure of water vapour from relative humidity and temperature
* - :func:`~pyjams.rhair2vpd`
* - :func:`~pyjams.air_humidity.rhair2vpd`
- Air vapour pressure deficit from relative humidity and temperature
* - :func:`~pyjams.shair2eair`
* - :func:`~pyjams.air_humidity.shair2eair`
- Partial pressure of water vapour from specific humidity and total pressure
* - :func:`~pyjams.vpd2eair`
* - :func:`~pyjams.air_humidity.vpd2eair`
- Partial pressure of water vapour from air vapour pressure deficit and temperature
* - :func:`~pyjams.vpd2rhair`
* - :func:`~pyjams.air_humidity.vpd2rhair`
- Relative humidity from air vapour pressure deficit and temperature

.. _Miscellaneous:
Expand All @@ -491,7 +491,7 @@ Functions and modules per category
- Integer to Roman numeral conversion
* - :func:`~pyjams.romanliterals.roman2int`
- Roman numeral to integer conversion
* - :func:`~pyjams.tee`
* - :func:`~pyjams.tee.tee`
- Prints arguments on screen and in file, like Unix/Linux tee utility

.. _Plotting:
Expand All @@ -509,15 +509,15 @@ Functions and modules per category
- Collection of color palettes and continuous color maps
* - :func:`~pyjams.romanliterals.int2roman`
- Integer to Roman numeral conversion
* - :class:`~pyjams.mcPlot`
* - :class:`~pyjams.mcplot.mcPlot`
- Matthias Cuntz' standard plotting class
* - :func:`~pyjams.position`
* - :func:`~pyjams.position.position`
- Position arrays of subplots to be used with add_axes
* - :func:`~pyjams.romanliterals.roman2int`
- Roman numeral to integer conversion
* - :func:`~pyjams.text2plot.signature2plot`
- Write a copyright notice on a plot
* - :func:`~pyjams.str2tex`
* - :func:`~pyjams.str2tex.str2tex`
- Convert strings to LaTeX strings in math environment used by
matplotlib's usetex
* - :func:`~pyjams.text2plot.text2plot`
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 7bc56f4

Please sign in to comment.