Merge pull request #28 from IBM/v0.5.2.0b

V0.5.2.0
IBM · Dec 26, 2021 · 656a2a0 · 656a2a0
2 parents 2714789 + b5b3b67
commit 656a2a0
Show file tree

Hide file tree

Showing 92 changed files with 4,353 additions and 16,248 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,28 +4,45 @@ All notable changes to this project will be documented in this file.
 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.5.1.0]
+## [Unreleased]## [0.5.2.0b]
 ### Changed
-- data asset folder location in CP4D v4.0.2 (with new git)
-- save Excel/lp/csv files using ibm_watson_studio_lib in CPD v4.0.2 in ScenarioManager
+- (minor) Release dates in this change log
+- ScenarioDbManager support for DB2 in cloud
+- Fixed AutoScenarioDbTable functionality in ScenarioDbManager
+- Bumped-up version to 0.5.2 due to many changes
+### Added
+- Optional forced platform/version in ScenarioManager
+- DataManager.print_inputs_outputs_summary() method
+- inputs and outputs arguments to ScenarioManager.__init__
+- Mixed-case db_table_name warning in ScenarioDbTable
+- DB-table-name reserved word warning in ScenarioDbTable
+- plotlymanager module
+- Cached read of scenarios table in ScenarioDbManager
+### Removed
+- (minor) Removed support for DSX as platform choice
+
+## [0.5.1.0] - 2021-11-30
+### Changed
+- Writing data asset in CP4DaaS (as of 30 Nov 2021)
+- Data asset folder location in CP4D v4.0.2 (with new git)
+- Save Excel/lp/csv files using ibm_watson_studio_lib in CPD v4.0.2 in ScenarioManager
 ### Added
 - DataManager.extract_solution static method
 - DataManager.get_raw_table_by_name method
 
-## [0.5.0.1]
+## [0.5.0.1] - 2021-10-29
 ### Changed
 - ScenarioManager.write_data_into_scenario now supports a template scenario name when creating a new scenario.
 
-## [0.5.0.0]
+## [0.5.0.0] - 2021-08-14
 ### Changed
 - Replace dd-scenario with decision-optimization-client==1.0.0 package (essential for CP4D 4.0)
 - Deprecated the DOModelExporter: dev does not support exporting a DO model in any way.
 - Fixed bug in ScenarioManager.create_new_scenario when using a template scenario
 ### Added
 - 
 
-## [0.4.1.0]
+## [0.4.1.0] - 2021-07-16
 ### Added
 - MultiScenarioManager
 - ScenarioManager.load_data_from_excel_s load subset of tables

diff --git a/VersioningReadMe.md b/VersioningReadMe.md
@@ -4,9 +4,14 @@ Steps:
 1. Change the version in the files `dse_do_utils.version.py` to something like `0.2.0`. 
 (`setup.py` and `/docs/source/conf.py` now automatically gets it from `version.py`)`
 
-2. Regenerate the documentation with `make-html` (see `docs/doc_readme.md`). 
+2. Regenerate the documentation with `make html` (see `docs/doc_readme.md`). 
 Open Terminal (Alt+F12), `cd docs`, run <br>
-`make html` 
+`make clean`
+`make html`
+If Powershell:
+`cmd.exe /c make html`
+Note that if you added/removed modules, you first need to re-run the sphinx command:
+`sphinx-apidoc -f -o source/ ../dse_do_utils/`
 
 3. For PyPI, build the wheel file.
 a. Delete all files in `./dist`

diff --git a/docs/doc_build/doctrees/dse_do_utils.doctree b/docs/doc_build/doctrees/dse_do_utils.doctree
diff --git a/docs/doc_build/doctrees/environment.pickle b/docs/doc_build/doctrees/environment.pickle
diff --git a/docs/doc_build/html/.buildinfo b/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: ae5be61784e7bcb9afedc66f36b7f200
+config: 2c638b537d47ae366d7130796eb498ee
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/doc_build/html/_modules/dse_do_utils.html b/docs/doc_build/html/_modules/dse_do_utils.html
@@ -6,7 +6,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>dse_do_utils &#8212; DSE DO Utils 0.5.0.0b documentation</title>
+    <title>dse_do_utils &#8212; DSE DO Utils 0.5.2.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css" />
 
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">DSE DO Utils 0.5.0.0b documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">DSE DO Utils 0.5.2.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dse_do_utils</a></li> 
       </ul>
@@ -169,7 +169,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">DSE DO Utils 0.5.0.0b documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">DSE DO Utils 0.5.2.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" >Module code</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dse_do_utils</a></li> 
       </ul>

diff --git a/docs/doc_build/html/_modules/dse_do_utils/cpd25utilities.html b/docs/doc_build/html/_modules/dse_do_utils/cpd25utilities.html
@@ -1,164 +1,47 @@
 
 
-<!DOCTYPE html>
-<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
-<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
-<head>
-  <meta charset="utf-8">
-
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-  <title>dse_do_utils.cpd25utilities &mdash; DSE DO Utils 0.4.0.1 documentation</title>
-
-
-
-
-
-
-
-
-  <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
-
+<!doctype html>
+
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>dse_do_utils.cpd25utilities &#8212; DSE DO Utils 0.5.2.0 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css" />
 
-      <script type="text/javascript">
-          var DOCUMENTATION_OPTIONS = {
-              URL_ROOT:'../../',
-              VERSION:'0.4.0.1',
-              LANGUAGE:'None',
-              COLLAPSE_INDEX:false,
-              FILE_SUFFIX:'.html',
-              HAS_SOURCE:  true,
-              SOURCELINK_SUFFIX: '.txt'
-          };
-      </script>
-        <script type="text/javascript" src="../../_static/jquery.js"></script>
-        <script type="text/javascript" src="../../_static/underscore.js"></script>
-        <script type="text/javascript" src="../../_static/doctools.js"></script>
-
-    <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
-
-
-
-  <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
-  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+    <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
+    <script src="../../_static/jquery.js"></script>
+    <script src="../../_static/underscore.js"></script>
+    <script src="../../_static/doctools.js"></script>
+    <script src="../../_static/bizstyle.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
-    <link rel="search" title="Search" href="../../search.html" /> 
-</head>
-
-<body class="wy-body-for-nav">
-
-
-  <div class="wy-grid-for-nav">
-
-    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
-      <div class="wy-side-scroll">
-        <div class="wy-side-nav-search" >
-
-
-
-            <a href="../../index.html" class="icon icon-home"> DSE DO Utils
-
-
-
-          </a>
-
-
-
-
-              <div class="version">
-                0.4.0.1
-              </div>
-
-
-
-
-<div role="search">
-  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
-    <input type="text" name="q" placeholder="Search docs" />
-    <input type="hidden" name="check_keywords" value="yes" />
-    <input type="hidden" name="area" value="default" />
-  </form>
-</div>
-
-
-        </div>
-
-        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
-
-
-
-
-
-
-              <p class="caption"><span class="caption-text">Contents:</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../readme_link.html">Read me</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../readme_link.html#dse-do-utils">DSE_DO_Utils</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../modules.html">Modules</a></li>
-</ul>
-
-
-
-        </div>
-      </div>
-    </nav>
-
-    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
-
-
-      <nav class="wy-nav-top" aria-label="top navigation">
-
-          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../index.html">DSE DO Utils</a>
-
-      </nav>
-
-
-      <div class="wy-nav-content">
-
-        <div class="rst-content">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<div role="navigation" aria-label="breadcrumbs navigation">
-
-  <ul class="wy-breadcrumbs">
-
-      <li><a href="../../index.html">Docs</a> &raquo;</li>
-
-          <li><a href="../index.html">Module code</a> &raquo;</li>
-
-          <li><a href="../dse_do_utils.html">dse_do_utils</a> &raquo;</li>
-
-      <li>dse_do_utils.cpd25utilities</li>
-
-
-      <li class="wy-breadcrumbs-aside">
-
-      </li>
-
-  </ul>
-
-
-  <hr/>
-</div>
-          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
-           <div itemprop="articleBody">
+    <link rel="search" title="Search" href="../../search.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="_static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.2.0 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
+          <li class="nav-item nav-item-2"><a href="../dse_do_utils.html" accesskey="U">dse_do_utils</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">dse_do_utils.cpd25utilities</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
 
   <h1>Source code for dse_do_utils.cpd25utilities</h1><div class="highlight"><pre>
 <span></span><span class="c1"># Copyright IBM All Rights Reserved.</span>
@@ -299,43 +182,44 @@ <h1>Source code for dse_do_utils.cpd25utilities</h1><div class="highlight"><pre>
         <span class="n">project</span><span class="o">.</span><span class="n">save_data</span><span class="p">(</span><span class="n">file_name</span><span class="o">=</span><span class="n">asset_name</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">f</span><span class="p">,</span> <span class="n">overwrite</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>
 </pre></div>
 
-           </div>
-
+            <div class="clearer"></div>
           </div>
-          <footer>
-
-
-  <hr/>
-
-  <div role="contentinfo">
-    <p>
-        &copy; Copyright 2019, Victor Terpstra
-
-    </p>
-  </div>
-  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
-
-</footer>
-
         </div>
       </div>
-
-    </section>
-
-  </div>
-
-
-
-  <script type="text/javascript">
-      jQuery(function () {
-          SphinxRtdTheme.Navigation.enable(true);
-      });
-  </script>
-
-
-
-
-
-
-</body>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">DSE DO Utils 0.5.2.0 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
+          <li class="nav-item nav-item-2"><a href="../dse_do_utils.html" >dse_do_utils</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">dse_do_utils.cpd25utilities</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+        &#169; Copyright 2019, Victor Terpstra.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.1.
+    </div>
+  </body>
 </html>