Release v1.4.0 (#97)

* Update readme * Add whatsnew file
SunPower · Nov 21, 2019 · e152a8b · e152a8b
1 parent 97b8945
commit e152a8b
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 14 deletions.
diff --git a/README.rst b/README.rst
@@ -141,7 +141,8 @@ The users can also create a "report" while running the simulations that will rel
 .. code:: python
 
     # Create a function that will build a report
-    def fn_report(pvarray): return {'qinc_back': pvarray.ts_pvrows[1].back.get_param_weighted('qinc')}
+    def fn_report(pvarray): return {'total_incident_back': pvarray.ts_pvrows[1].back.get_param_weighted('qinc'),
+                                    'total_absorbed_back': pvarray.ts_pvrows[1].back.get_param_weighted('qabs')}
 
     # Run full mode simulation
     report = engine.run_full_mode(fn_build_report=fn_report)
@@ -151,13 +152,13 @@ The users can also create a "report" while running the simulations that will rel
     df_report
 
 
-+---------------------+------------+
-|                     | qinc_back  |
-+=====================+============+
-| 2017-08-31 11:00:00 | 106.627832 |
-+---------------------+------------+
-| 2017-08-31 15:00:00 | 79.668878  |
-+---------------------+------------+
++---------------------+---------------------+---------------------+
+|                     | total_incident_back | total_absorbed_back |
++=====================+=====================+=====================+
+| 2017-08-31 11:00:00 |          106.627832 |          103.428997 |
++---------------------+---------------------+---------------------+
+| 2017-08-31 15:00:00 |          79.668878  |           77.278812 |
++---------------------+---------------------+---------------------+
 
 
 

diff --git a/docs/sphinx/whatsnew.rst b/docs/sphinx/whatsnew.rst
@@ -1,11 +1,12 @@
-.. whatsnew:
+.. _whatsnew:
 
 **********
 What's New
 **********
 
 These are new features and improvements of note in each release.
 
+.. include:: whatsnew/v1.4.0.rst
 .. include:: whatsnew/v1.3.0.rst
 .. include:: whatsnew/v1.2.2.rst
 .. include:: whatsnew/v1.2.1.rst

diff --git a/docs/sphinx/whatsnew/v1.4.0.rst b/docs/sphinx/whatsnew/v1.4.0.rst
@@ -0,0 +1,22 @@
+.. _whatsnew_1400:
+
+v1.4.0 (November 21, 2019)
+==========================
+
+Enhancements
+------------
+
+pvfactors can now account for AOI losses by either using constant diffuse losses, are by using an fAOI function that will provide the corresponding loss for each value of angle of incidence.
+
+* Test for continuity of results with direct shading (#91)
+* Implement non-diffuse AOI loss methods (#92)
+* Implement fAOI modifiers for irradiance models (#93)
+* Merge new AOI methods into full mode workflow (#94)
+* Include fAOI losses from irradiance models in tests (#95)
+* Update docs for AOI methods (#96)
+
+
+Contributors
+------------
+
+* Marc Anoma (:ghuser:`anomam`)
diff --git a/docs/tutorials/pvfactors_demo.ipynb b/docs/tutorials/pvfactors_demo.ipynb
@@ -312,26 +312,29 @@
        "  <thead>\n",
        "    <tr style=\"text-align: right;\">\n",
        "      <th></th>\n",
-       "      <th>qinc_back</th>\n",
+       "      <th>total_incident_back</th>\n",
+       "      <th>total_absorbed_back</th>\n",
        "    </tr>\n",
        "  </thead>\n",
        "  <tbody>\n",
        "    <tr>\n",
        "      <td>2017-08-31 11:00:00</td>\n",
        "      <td>106.627832</td>\n",
+       "      <td>103.428997</td>\n",
        "    </tr>\n",
        "    <tr>\n",
        "      <td>2017-08-31 15:00:00</td>\n",
        "      <td>79.668878</td>\n",
+       "      <td>77.278812</td>\n",
        "    </tr>\n",
        "  </tbody>\n",
        "</table>\n",
        "</div>"
       ],
       "text/plain": [
-       "                      qinc_back\n",
-       "2017-08-31 11:00:00  106.627832\n",
-       "2017-08-31 15:00:00   79.668878"
+       "                     total_incident_back  total_absorbed_back\n",
+       "2017-08-31 11:00:00           106.627832           103.428997\n",
+       "2017-08-31 15:00:00            79.668878            77.278812"
       ]
      },
      "execution_count": 9,
@@ -341,7 +344,8 @@
    ],
    "source": [
     "# Create a function that will build a report\n",
-    "def fn_report(pvarray): return {'qinc_back': pvarray.ts_pvrows[1].back.get_param_weighted('qinc')}\n",
+    "def fn_report(pvarray): return {'total_incident_back': pvarray.ts_pvrows[1].back.get_param_weighted('qinc'),\n",
+    "                                'total_absorbed_back': pvarray.ts_pvrows[1].back.get_param_weighted('qabs')}\n",
     "\n",
     "# Run full mode simulation\n",
     "report = engine.run_full_mode(fn_build_report=fn_report)\n",