Documentation
=================

TENAX class
-------------------
.. automodule:: pyTENAX.tenax
   :members: TENAX
   :undoc-members:
   :show-inheritance:

Supporting utils
-------------------
.. automodule:: pyTENAX.tenax
   :no-index:
   :members: MC_tSMEV_cdf, SMEV_Mc_inversion, gen_norm_loglik, gen_norm_pdf, inverse_magnitude_model, randdf, wbl_leftcensor_loglik, wbl_leftcensor_loglik_H0shape, wbl_leftcensor_loglik_bset
   :undoc-members:
   :show-inheritance:
 
Plotting utils
-------------------   
.. automodule:: pyTENAX.plotting
   :members: TNX_FIG_magn_model, TNX_FIG_temp_model, TNX_FIG_valid, TNX_FIG_scaling, TNX_obs_scaling_rate
   :undoc-members:
   :show-inheritance:
   
   
Supporting SMEV class
----------------------
The `SMEV` implementation in `pyTENAX` builds upon the concepts from the 
`pysmev <https://github.com/luigicesarini/pysmev>`_ library.

.. automodule:: pyTENAX.smev
   :members:
   :undoc-members:
   :show-inheritance:
   
   
Weibull tail test 
----------------------
Original code written in MATLAB is available at:
https://zenodo.org/records/7234708
For now, users can refer to the file tests/test_weibull_test.py to see how to use this code.

.. automodule:: pyTENAX.wbl_tail_test
   :members:
   :undoc-members:
   :show-inheritance: