updating docs for 0.6.0 release

MatthewReid854 · Jul 22, 2021 · 98e8dc5 · 98e8dc5
1 parent 107855e
commit 98e8dc5
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 8 deletions.
diff --git a/docs/API/Fitters/Fit_Weibull_DSZI.rst b/docs/API/Fitters/Fit_Weibull_DSZI.rst
@@ -0,0 +1,10 @@
+.. image:: https://raw.githubusercontent.com/MatthewReid854/reliability/master/docs/images/logo.png
+
+-------------------------------------
+
+Fit_Weibull_DSZI
+----------------
+
+.. autoclass:: reliability.Fitters.Fit_Weibull_DSZI
+    :members:
+    :undoc-members:
diff --git a/docs/Changelog.rst b/docs/Changelog.rst
@@ -5,12 +5,12 @@
 Changelog
 ---------
 
-**Version: 0.6.0 --- Currently Unreleased --- Due for release around August 2021**
-'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+**Version: 0.6.0 --- Released: 23 July 2021**
+'''''''''''''''''''''''''''''''''''''''''''''
 
 **Summary of changes**
 
--    This version has two main improvements. Firstly the behaviour of the optimizers has been changed to be more efficient, and to allow users to try multiple optimizers easily by specifying optimizer='best'.
+-    Version 0.6.0 has two main improvements. Firstly the behaviour of the optimizers has been changed to be more efficient, and to allow users to try multiple optimizers easily by specifying optimizer='best'.
      Secondly, the addition of the Defective Subpopulation (DS) and Zero Inflated (ZI) Model now provides a model for which the CDF can range from above 0 to below 1.
      There are several new Fitters added to take advantage of this as detailed below.
 
@@ -31,8 +31,8 @@ Changelog
 **Other**
 
 -    The default optimizer has been changed. Previously it was 'L-BFGS-B' for < 97% censored data and 'TNC' above 97% censored data. Now it is 'TNC'. For more detail and a flowchart description of the default behaviour, see the documentation on `Optimizers <https://reliability.readthedocs.io/en/latest/Optimizers.html>`_.
--    The optimizer used is now reported in the printed results for all Fitters and ALT_Fitters.
--    Removed support for Python 3.6 due to scipy 1.7.0 dropping this Python version.
+-    The optimizer used is now reported in the printed results for all of the Fitters and ALT_Fitters.
+-    Removed support for Python 3.6 due to scipy 1.7.0 dropping support for this Python version.
 -    Change to the algorithm used in Other_functions.make_right_censored_data when making multiply censored data. The algorithm used is explained `here <https://reliability.readthedocs.io/en/latest/Make%20right%20censored%20data.html#example-2>`_.
 -    Significant speed improvement to Other_functions.make_right_censored_data when making multiply censored data.
 -    Change to the versioning system. The new system is major.minor.bugfix whereas the previous system was reserved.major.minor. This should allow more frequent bugfix releases.

diff --git a/docs/DSZI models.rst b/docs/DSZI models.rst
@@ -101,7 +101,7 @@ Fitting a DSZI model
 
 .. admonition:: API Reference
 
-   For inputs and outputs see the API reference for `Fit_Weibull_DS <https://reliability.readthedocs.io/en/latest/API/Fitters/Fit_Weibull_DS.html>`_ and `Fit_Weibull_ZI <https://reliability.readthedocs.io/en/latest/API/Fitters/Fit_Weibull_ZI.html>`_.
+   For inputs and outputs see the API reference for `Fit_Weibull_DS <https://reliability.readthedocs.io/en/latest/API/Fitters/Fit_Weibull_DS.html>`_, `Fit_Weibull_ZI <https://reliability.readthedocs.io/en/latest/API/Fitters/Fit_Weibull_ZI.html>`_, and `Fit_Weibull_DSZI <https://reliability.readthedocs.io/en/latest/API/Fitters/Fit_Weibull_DSZI.html>`_.
 
 As we saw above, the DSZI_Model can be either DS, ZI, or DSZI depending on the values of the DS and ZI parameters.
 Within the Fitters module, three functions are offered, one of each of these cases with the Weibull_2P distribution as the base distribution.

diff --git a/docs/Development roadmap.rst b/docs/Development roadmap.rst
@@ -25,3 +25,4 @@ The current release schedule is approximately every 6 to 8 weeks.
 -    New reliability growth models. Currently there is only the Duane model. It is planned to include the Crow Extended and AMSAA PM2 models.
 -    Cox Proportional Hazards Model - This is available in `Lifelines <https://lifelines.readthedocs.io/en/latest/Survival%20Regression.html#cox-s-proportional-hazard-model>`_.
 -    Add `step-stress models <http://reliawiki.com/index.php/Time-Varying_Stress_Models>`_ to ALT models.
+-    Confidence intervals for Mixture Model, Competing Risks Model, DS model, ZI model, and DSZI model.
diff --git a/reliability/__init__.py b/reliability/__init__.py
@@ -15,7 +15,7 @@
 from reliability import Convert_data
 
 __title__ = 'reliability'
-__version__ = "0.5.8"
+__version__ = "0.6.0"
 __description__ = 'A Python library for reliability engineering'
 __url__ = 'https://reliability.readthedocs.io/en/latest/index.html'
 __author__ = 'Matthew Reid'

diff --git a/setup.py b/setup.py
@@ -7,7 +7,7 @@
 
 setuptools.setup(
     name="reliability",
-    version="0.5.8",
+    version="0.6.0",
     description="Reliability Engineering toolkit for Python",
     author="Matthew Reid",
     author_email="alpha.reliability@gmail.com",
@@ -54,6 +54,13 @@
         "mean",
         "cumulative",
         "CIF",
+        "DS",
+        "ZI",
+        "defective",
+        "subpopulation",
+        "zero",
+        "inflated",
+        "DSZI",
     ],
     long_description=long_description,
     long_description_content_type="text/markdown",