Merge pull request #105 from agmoore4/docs-update

updating docs to reflect recent changes and disabling test affected by nltk

Author: agmoore4

docs/pages/installation.rst

@@ -18,11 +18,11 @@ Alternatively, the package can be installed using github::
 NLTK data
 ----------
 
-Functions in the text package rely on the "punkt" dataset from the nltk package.
+Functions in the text package rely on the "punkt_tab" dataset from the nltk package.
 After proper installation of pvops, run the commands::
     
     >>> import nltk
-    >>> nltk.download('punkt')
+    >>> nltk.download('punkt_tab')
     >>> nltk.download('stopwords')
 
 Those operating under a proxy may have difficulty with this installation.

docs/pages/releasenotes.rst

@@ -5,6 +5,14 @@ What's New
 
 These are new features and improvements of note in each release.
 
+.. include:: releasenotes/0.5.2.rst
+
+.. include:: releasenotes/0.5.1.rst
+
+.. include:: releasenotes/0.5.0.rst
+
+.. include:: releasenotes/0.4.0.rst
+
 .. include:: releasenotes/0.3.0.rst
 
 .. include:: releasenotes/0.2.0.rst

docs/pages/releasenotes/0.4.0.rst

@@ -0,0 +1,19 @@
+0.4.0 (October 25 2024)
+-----------------------
+
+This release primarily addresses deprecations and future warnings related to dependencies, including a significant security vulnerability.
+
+Documentation
+~~~~~~~~~~~~~
+
+* Updated README and documentation to point to the JOSS publication.
+
+Tutorials
+~~~~~~~~~~~~~~
+
+* Miscellaneous fixes relevant to text2time, time, timeseries AIT module tutorials.
+
+Other
+~~~~~~~~~~~~~~
+
+* Now requiring nltk>=3.9.1 and switching punkt to punkt_tab. This addresses a security vulnerability in nltk.

docs/pages/releasenotes/0.5.0.rst

@@ -0,0 +1,16 @@
+0.5.0 (February 19 2025)
+------------------------
+
+This release adds a new tutorial demonstrating survival analysis on PV assets.
+
+Tutorials
+~~~~~~~~~~~~~~
+
+* Added a new timeseries survival analysis tutorial demonstrating Kaplan-Meier estimators and Weibull distribution fits.
+
+* Added a new example dataset to go along with the new tutorial.
+
+Other
+~~~~~~~~~~~~~~
+
+* Added scikit-survival as a new dependency. Used for Kaplan-Meier estimators in the new tutorial.

docs/pages/releasenotes/0.5.1.rst

@@ -0,0 +1,9 @@
+0.5.1 (February 19 2025)
+------------------------
+
+This release addresses a deprecation preventing the documentation from building.
+
+Other
+~~~~~~~~~~~~~~
+
+* Updated artifact/upload-artifact in buildthedocs from v3 to v4

docs/pages/releasenotes/0.5.2.rst

@@ -0,0 +1,15 @@
+0.5.1 (February 19 2025)
+------------------------
+
+This release updates the documentation to reflect changes starting at v0.4.0 and fixes dependency requirements.
+
+Other
+~~~~~~~~~~~~~~
+
+* Updated release notes to include changes starting at v0.4.0.
+
+* Added new survival analysis notebook to the documentation.
+
+* In v0.5.0, scikit-survival was added to requirements.txt but not setup.py. That has been resolved.
+
+* Now requiring python<3.13 for tensorflow

docs/pages/tutorials.rst

@@ -10,11 +10,12 @@ Check out the tutorials below!
    tutorials/tutorial_textmodule
 
 .. nbgallery::
-   :caption: Energy modelling tutorials:
+   :caption: Timeseries tutorials:
 
    tutorials/tutorial_timeseries
    tutorials/tutorial_AIT_timeseries
    tutorials/tutorial_timeseries_sim
+   tutorials/tutorial_timeseries_survival_analysis
 
 .. nbgallery::
    :caption: IV tutorials:

docs/pages/tutorials/tutorial_timeseries_survival_analysis.nblink

@@ -0,0 +1,3 @@
+{
+    "path": "../../../tutorials/tutorial_timeseries_survival_analysis.ipynb"
+}

pvops/__init__.py

@@ -8,7 +8,7 @@
     # warnings.warn("")
     pass
 
-__version__ = '0.5.0'
+__version__ = '0.5.2'
 
 __copyright__ = """Copyright 2023 National Technology & Engineering 
 Solutions of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 

pvops/tests/test_text.py

@@ -15,6 +15,10 @@ def test_text_remove_nondate_nums():
     assert preprocess.text_remove_nondate_nums(example) == answer
 
 
+##### REMOVE ONCE NLTK STOPWORDS ISSUE IS RESOLVED
+import pytest
+@pytest.mark.skip(reason="no way of currently testing this")
+#####
 def test_text_remove_numbers_stopwords():
     example = r"This is a test example 10% #10 101 1-1-1 13-1010 10.1 123456789 123/12 executed on 2/4/2020"
     answer = r"This test example executed"