556 deprecationwarning

bifacial_radiance/load.py

@@ -7,6 +7,8 @@
 TEMP folder in bifacial_radiance \\ bifacial_radiance
 
 """
+from deprecated import deprecated
+
 ''' DEPRECATED - doesn't work with python3
 def load_inputvariablesfile(inputfile):
     """
@@ -235,7 +237,7 @@ def loadTrackerDict(trackerdict, fileprefix=None):
         ``finalkey`` (last index file in directory)
 
     """
-
+    # TODO: get this module working   
     import re, os
     import numpy as np
 
@@ -327,6 +329,9 @@ def _exportTrackerDict(trackerdict, savefile, reindex):
     d.to_csv(savefile)    
 
 
+@deprecated(reason='load.deepcleanResult has been abandoned'+\
+                    '  Please use load.cleanResult instead',
+            version='0.5.0')    
 def deepcleanResult(resultsDict, sensorsy, numpanels, automatic=True):
     """    
     Cleans results file read by read1Result. If automatic = False, user is
@@ -335,6 +340,10 @@ def deepcleanResult(resultsDict, sensorsy, numpanels, automatic=True):
     If you pass in results from a file with only _Front or _Back parameters,
     only the corresponding Frontresults or Backresults will be returned.
 
+    .. deprecated:: 0.5.0
+       This cleaning routine is deprecated in favor of :func:`cleanResult` which 
+       is more stable
+
     Parameters
     -----------
     sensorsy : int

bifacial_radiance/main.py

@@ -60,6 +60,8 @@
 import pandas as pd
 import numpy as np 
 import warnings
+from deprecated import deprecated
+
 #from input import *
 
 # Mutual parameters across all processes

bifacial_radiance/mismatch.py

@@ -5,7 +5,7 @@
 @author: sayala
 """
 
-#from load import * 
+from deprecated import deprecated
 
 
 
@@ -300,7 +300,8 @@ def _mad_1D(data):  #1D calculation of MAD
         return _mad_1D(data)
 
 
-
+@deprecated(reason='This analysis script will be moved to its own tutorial' +\
+            ' file in a future release.', version='0.5.0')
 def analysisIrradianceandPowerMismatch(testfolder, writefiletitle, portraitorlandscape, bififactor, numcells=72, downsamplingmethod='byCenter'):
     r'''
     Use this when sensorsy calculated with bifacial_radiance > cellsy

docs/sphinx/source/whatsnew/pending.rst

@@ -18,6 +18,8 @@ Enhancements
 Deprecations
 ~~~~~~~~~~~~~~
 * .ini files loaded with :py:func:`bifacial_radiance.load.readconfigurationinputfile` use `azimuth` key instead of `axis_azimuth`  (:issue:`438`)(:pull:`551`)
+* :py:func:`bifacial_radiance.load.deepcleanResult` is now deprecated in favor of :py:func:`~bifacial_radiance.load.cleanResult` (:issue:`556`)
+* :py:func:`bifacial_radiance.mismatch.analysisIrradianceandPowerMismatch` is being removed to its own example notebook in a future release. (:issue:`556`)
 
 Bug fixes
 ~~~~~~~~~

setup.py

@@ -98,6 +98,7 @@
         'configparser',
         'requests',
         'pyradiance',
+        'deprecated'
         ],
 
     # List additional groups of dependencies here (e.g. development