Skip to content

Commit

Permalink
fixing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewReid854 committed Nov 10, 2021
1 parent f7fd955 commit c3301d7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 11 deletions.
9 changes: 0 additions & 9 deletions docs/How does Maximum Likelihood Estimation work.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,3 @@ How does Maximum Likelihood Estimation work
'''''''''''''''''''''''''''''''''''''''''''

This is a placeholder for a theory document which will be written soon.


Ignore this. It is for another test.

The Arrhenius model for Acceleration factor due to higher temperature is:

:math:`AF = exp\left(\frac{Ea}{K\left(\frac{1}{T_{use}}-\frac{1}{T_{acc}}\right)}\right)`

K is the Boltzmann constant :math:`8.617333262145 \times 10^{-5}` eV/Kelvin
6 changes: 4 additions & 2 deletions reliability/PoF.py
Original file line number Diff line number Diff line change
Expand Up @@ -2329,8 +2329,10 @@ def creep_failure_time(temp_low, temp_high, time_low, C=20, print_results=True):

class acceleration_factor:
"""
The Arrhenius model for Acceleration factor due to higher temperature is :math:`AF = {\rm exp} \left(\frac{Ea}{K\left(\frac{1}{T_{use}}-\frac{1}{T_{acc}}\right)}\right)`.
Where K is the Boltzmann constant :math:`8.617333262145 × 10^{-5}` eV/Kelvin
This function uses the Arrhenius model for Acceleration factor to determine
the relationship between temperature and reaction rate.
Please see the `online documentation <https://reliability.readthedocs.io/en/latest/Acceleration%20factor.html>`_ for more details and formulas.
This function accepts T_use as a mandatory input and the user may specify
any two of the three other variables, and the third variable will be found.
Expand Down

0 comments on commit c3301d7

Please sign in to comment.