update docstrings / whatsnew

NREL · Sep 25, 2024 · 8e069ba · 8e069ba
1 parent 9db0930
commit 8e069ba
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/bifacial_radiance/load.py b/bifacial_radiance/load.py
@@ -477,8 +477,10 @@ def readconfigurationinputfile(inifile=None):
     trackingParamsDict : Dictionary
     torquetubeParamsDict : Dictionary
     analysisParamsDict : Dictionary
-    cellLevelModuleParamsDict : Dictionary
-
+    cellModuleDict : Dictionary
+    frameParamsDict : Dictionary
+    omegaParamsDict : Dictionary
+    
     """
 
     ## #TODO: check if modulename exists on jason and rewrite is set to false, then

diff --git a/docs/sphinx/source/whatsnew/pending.rst b/docs/sphinx/source/whatsnew/pending.rst
@@ -7,22 +7,27 @@ Bugfix Release  ...
 
 API Changes
 ~~~~~~~~~~~~
-* New input parameter to :py:class:`~bifacial_radiance.ModuleObj and :py:class:`~bifacial_radiance.RadianceObj.makeModule`:  `glassEdge`.  If :py:class:`~bifacial_radiance.RadianceObj.makeModule` `glass` = True, then this extends the glass past the absorber edge by this total amount (half in each x and y direction). Default 10mm.
-* Module glass thickness can be changed. In :py:class:`~bifacial_radiance.RadianceObj.makeModule`, if `glass` = True, then setting the `z` parameter will indicate the total (front + back) glass thickness with the 1mm absorber in the middle.  The default is z = 10mm.
+* New input parameter to :py:class:`~bifacial_radiance.ModuleObj and :py:func:`~bifacial_radiance.RadianceObj.makeModule`:  `glassEdge`.  If :py:class:`~bifacial_radiance.RadianceObj.makeModule` `glass` = True, then this extends the glass past the absorber edge by this total amount (half in each x and y direction). Default 10mm.
+* Module glass thickness can be changed. In :py:func:`~bifacial_radiance.RadianceObj.makeModule`, if `glass` = True, then setting the `z` parameter will indicate the total (front + back) glass thickness with the 1mm absorber in the middle.  The default is z = 10mm.
 
 Enhancements
 ~~~~~~~~~~~~
 * Conduct an automated check for proper radiance RAYPATH setting (:issue:`525`)(:pull:`537`)
 
 
+Deprecations
+~~~~~~~~~~~~~~
+* .ini files loaded with :py:func:`bifacial_radiance.load.readconfigurationinputfile` use `azimuth` key instead of `axis_azimuth`  (:issue:`438`)(:pull:`551`)
+
 Bug fixes
 ~~~~~~~~~
 * Fixed a major error with indexing the irradiance conditions with :py:func:`~bifacial_radiance.RadianceObj.gendaylit1axis`. This could result in the trackerdict entry being mismatched from the metdata resource. (:issue:`441`)
 * versioning with setuptools_scm- set fallback_version to bifirad v0.4.3 to prevent crashes if git is not present (:issue:`535`)(:pull:`539`)
+* :py:func:`bifacial_radiance.load.readconfigurationinputfile` now properly handles loading moduleObj parameters from .ini files: `glass`, `glassEdge`, `frameParamsDict`, `omegaParamsDict` (:pull:`551`)
 
 Documentation
 ~~~~~~~~~~~~~~
-* No longer provide a warning message when both `hub_height` and `clearance_height` are passed to :py:class:`~bifacial_radiance.AnalysisObj.moduleAnalysis`  (:pull:`540`)
+* No longer provide a warning message when both `hub_height` and `clearance_height` are passed to :py:func:`~bifacial_radiance.AnalysisObj.moduleAnalysis`  (:pull:`540`)
 * More useful __repr__ output in :py:class:`~bifacial_radiance.AnalysisObj and :py:class:`~bifacial_radiance.MetObj   (:issue:`471`)
 
 Contributors