Merge pull request #12 from IBM/v0.4.0.1b

V0.4.0.1 release

CHANGELOG.md

@@ -5,9 +5,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.4.0.1] 
+### Added
+- ScenarioManager.write_data_to_excel returns Excel filepath
+
+### Changed
+- Fix in DataManager.df_crossjoin_ai to make compatible with Pandas 1.0
+
+## [0.4.0.0] - 2020-06-23
+### Changed
+- Support for WS Cloud (project context in Client)
+- More flexibility on accepting Boolean values as float or int parameter 
+### Added
+- Python data types in code
 
 ## [0.3.0.1] - 2020-03-04
-## Added
+### Added
 - DOModelExporter: export DO models in CPDv2.5
 - cpd25utilities: some data asset read and write functions
 

README.md

@@ -62,6 +62,33 @@ To be used within:
 1. CPDv2.1 (version 0.2.2.3 is preferred. But version 0.3.0.0 should be backwards compatible.)
 2. CPDv2.5 (version 0.3.0.0 and up)
 3. WSLv1.2.3 with Python 2.7 (version 0.2.2.3 only)
+4. WS Cloud (version 0.4.0.0 and up)
+
+## DO Model Builder and WML environments
+When developing and using optimization models, there are 3 different environments the Python DO model might run in:
+1. A notebook environment. 
+2. The DO Model Builder environment.
+3. The WML deployment environment.
+
+In CPDv2.5:
+* Only the notebook environment can be regularly customized with the dse-do-utils.
+* The Model Builder environment cannot be customized. But, it has a feature to add 'files'. 
+The dse-do-utils internal modules have been refactored to be able to be uploaded separately as individual modules.
+* The WML environment cannot be customized. But the same work-around for adding modules/files to the MB model can be used.
+
+In CPDv3.0:
+* The WML environment can be customized using APIs.
+
+In future releases of CPD:
+* The DO Model Builder will also allow for environment customization
+
+## Scope of classes/modules
+The classes `OptimizationEngine` and  `DataManager` are intended to be used within the optimization model code 
+that will run in the Model Builder and WML deployment. All other classes, in particular the `ScenarioManager` are 
+designed to be used outside of the Model Builder or WML, e.g. within `#dd-ignore` cells.
+
+Therefore, the limitations in customizing environments can, for the moment, be avoided by not using 
+the classes `OptimizationEngine` and  `DataManager`.
 
 ## Requirements
 This package requires:

docs/doc_build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: a4807da18cd21515904f1b5ead8dcaca
+config: acaac8f8746b71afc8fcd8e80934e7f8
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/doc_build/html/_modules/dse_do_utils.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>dse_do_utils &mdash; DSE DO Utils 0.3.0.2b documentation</title>
+  <title>dse_do_utils &mdash; DSE DO Utils 0.4.0.1 documentation</title>
 
 
 
@@ -23,7 +23,7 @@
       <script type="text/javascript">
           var DOCUMENTATION_OPTIONS = {
               URL_ROOT:'../',
-              VERSION:'0.3.0.2b',
+              VERSION:'0.4.0.1',
               LANGUAGE:'None',
               COLLAPSE_INDEX:false,
               FILE_SUFFIX:'.html',
@@ -67,7 +67,7 @@
 
 
               <div class="version">
-                0.3.0.2b
+                0.4.0.1
               </div>
 
 
@@ -228,19 +228,19 @@ <h1>Source code for dse_do_utils</h1><div class="highlight"><pre>
 <span class="sd">    Returns:</span>
 
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="kn">import</span> <span class="nn">imp</span>
+    <span class="kn">import</span> <span class="nn">importlib</span>
     <span class="kn">import</span> <span class="nn">datamanager</span>
     <span class="kn">import</span> <span class="nn">optimizationengine</span>
     <span class="kn">import</span> <span class="nn">scenariomanager</span>
     <span class="kn">import</span> <span class="nn">scenariopicker</span>
     <span class="kn">import</span> <span class="nn">deployeddomodel</span>
     <span class="kn">import</span> <span class="nn">mapmanager</span>
-    <span class="n">imp</span><span class="o">.</span><span class="n">reload</span><span class="p">(</span><span class="n">datamanager</span><span class="p">)</span>
-    <span class="n">imp</span><span class="o">.</span><span class="n">reload</span><span class="p">(</span><span class="n">optimizationengine</span><span class="p">)</span>
-    <span class="n">imp</span><span class="o">.</span><span class="n">reload</span><span class="p">(</span><span class="n">scenariomanager</span><span class="p">)</span>
-    <span class="n">imp</span><span class="o">.</span><span class="n">reload</span><span class="p">(</span><span class="n">scenariopicker</span><span class="p">)</span>
-    <span class="n">imp</span><span class="o">.</span><span class="n">reload</span><span class="p">(</span><span class="n">deployeddomodel</span><span class="p">)</span>
-    <span class="n">imp</span><span class="o">.</span><span class="n">reload</span><span class="p">(</span><span class="n">mapmanager</span><span class="p">)</span></div>
+    <span class="n">importlib</span><span class="o">.</span><span class="n">reload</span><span class="p">(</span><span class="n">datamanager</span><span class="p">)</span>
+    <span class="n">importlib</span><span class="o">.</span><span class="n">reload</span><span class="p">(</span><span class="n">optimizationengine</span><span class="p">)</span>
+    <span class="n">importlib</span><span class="o">.</span><span class="n">reload</span><span class="p">(</span><span class="n">scenariomanager</span><span class="p">)</span>
+    <span class="n">importlib</span><span class="o">.</span><span class="n">reload</span><span class="p">(</span><span class="n">scenariopicker</span><span class="p">)</span>
+    <span class="n">importlib</span><span class="o">.</span><span class="n">reload</span><span class="p">(</span><span class="n">deployeddomodel</span><span class="p">)</span>
+    <span class="n">importlib</span><span class="o">.</span><span class="n">reload</span><span class="p">(</span><span class="n">mapmanager</span><span class="p">)</span></div>
 
     <span class="c1"># The imports below cannot be done here.</span>
     <span class="c1"># You need to redo the class imports from the notebook that is calling this function</span>