{
"info": {
"author": "Victor Terpstra",
"author_email": "vterpstra@us.ibm.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 2.7",
"Topic :: Documentation :: Sphinx"
],
"description": "# DSE_DO_Utils\r\nDecision Optimization utilities for IBM Watson Studio Local and ICPd projects.\r\n\r\n[Source (GitHub)](https://github.com/IBM/dse-decision-optimization-utilities)
\r\n[Documentation (GitHubPages)](https://ibm.github.io/dse-decision-optimization-utilities/)\r\n\r\nThis repository contains the package `dse_do_utils`. This can be installed using pip.\r\n\r\n## Main classes:\r\n1. ScenarioManager. Reads and writes table data from and to all combinations of csv-files, Excel spreadhseet and DO scenario.\r\n2. DataManager. A DataManager is mostly a container for data and functions for pre- and post-processing. \r\nCan be subclassed and stored in a script to be able to share code between multiple notebooks. \r\nAlso contains some utilities for data manipulation, like the crossjoin.\r\n3. OptimizationEngine. Also mostly a container for functions around creating an optimization model and using the docplex APIs. \r\nCan be subclassed and stored in a script to be able to share code between multiple notebooks.\r\nAlso contains some functions to create dvars and export .lp files.\r\n4. ScenarioPicker. Interactively pick an existing scenario from a drop-down menu in a notebook. Typically used in visualization notebooks. \r\n5. MapManager. For creating map visualizations using Folium.\r\n6. DeployedDOModel. Interfacing from Python to a deployed DO model.\r\n\r\n## Installation\r\nRecommend to install in the `../packages/python` folder by running the following in a notebook cell:
\r\nRegular install:\r\n```\r\n!pip install dse-do-utils --target='../packages/python'\r\n```\r\nForce a released version to ensure compatibility (advised):\r\n```\r\n!pip install dse-do-utils==0.2.2.1 --target='../packages/python'\r\n```\r\nForce a clean re-install of a released version:\r\n```\r\n!pip install --force-reinstall dse-do-utils==0.2.2.1 --target='../packages/python' --upgrade\r\n```\r\n\r\nInstall from TestPyPI (deprecated, version on TestPyPI is not updated):\r\n```\r\n!pip install -i https://test.pypi.org/simple/dse-do-utils --target='../packages/python'\r\n```\r\nSee also [Installing packages and modules for Decision Optimization projects in Watson Studio Local](https://medium.com/@vjterpstracom/installing-packages-and-modules-for-decision-optimization-projects-in-watson-studio-local-69abc934ef32)\r\n\r\n## Import\r\nImport the `dse_do_utils` from the `../packages/python` folder.
\r\nFirst add the folder to the Python path:\r\n```\r\nimport sys, os\r\nfor folder in ['packages/python', 'scripts']:\r\n path = os.path.join(os.environ['DSX_PROJECT_DIR'], folder)\r\n if path not in sys.path:\r\n sys.path.insert(0, path)\r\n```\r\nThen import the required classes from the package:\r\n```\r\nfrom dse_do_utils import ScenarioManager, DataManager\r\n```\r\n\r\n## Target environments\r\nTo be used within:\r\n1. Watson Studio Local v1.2.3 (which requires Python 2.7).\r\n2. ICPd 1.2 or 2.1 (which requires Python 3.6)\r\nCurrently the dse_do_utils is maintained WSLv1.2.3 in Python 2.7. and tested against ICPd with Python 3.6.\r\n\r\n## Requirements\r\nThis package requires:\r\n1. [dd-scenario](https://pages.github.ibm.com/IBMDecisionOptimization/dd-scenario-api/dd-scenario-client-python/doc/build/html/). This package provides an interface to the DO scenarios. \r\nThis package is only available within WSL and ICPd. It cannot be pip installed in other environments.\r\n2. [docplex](http://ibmdecisionoptimization.github.io/docplex-doc/mp/index.html). This package interfaces with the CPLEX and CP Optimizer optimization engines.\r\n3. [folium](https://github.com/python-visualization/folium). Map visualization. Only for the MapManager.\r\n\r\n",
"description_content_type": "text/markdown",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/IBM/dse-decision-optimization-utilities",
"keywords": "",
"license": "",
"maintainer": "",
"maintainer_email": "",
"name": "dse-do-utils",
"package_url": "https://pypi.org/project/dse-do-utils/",
"platform": "",
"project_url": "https://pypi.org/project/dse-do-utils/",
"project_urls": {
"Documentation": "https://ibm.github.io/dse-decision-optimization-utilities/",
"Homepage": "https://github.com/IBM/dse-decision-optimization-utilities",
"IBM Decision Optimization": "https://www.ibm.com/analytics/decision-optimization",
"Source": "https://github.com/IBM/dse-decision-optimization-utilities"
},
"release_url": "https://pypi.org/project/dse-do-utils/0.2.2.3/",
"requires_dist": null,
"requires_python": "",
"summary": "Decision Optimization utilities for IBM Watson Studio projects",
"version": "0.2.2.3"
},
"last_serial": 5512804,
"releases": {
"0.2.2.2": [
{
"comment_text": "",
"digests": {
"md5": "60d732792d0a7367b044e3727adc9736",
"sha256": "e6ae5e0a8065753b20592384591a83214f280d525a4787c7a0a403d9d5b2bae2"
},
"downloads": -1,
"filename": "dse_do_utils-0.2.2.2-py2-none-any.whl",
"has_sig": false,
"md5_digest": "60d732792d0a7367b044e3727adc9736",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 36003,
"upload_time": "2019-07-09T14:01:12",
"url": "https://files.pythonhosted.org/packages/cb/10/06d1f33c4a544cc84d675c7301c99aed6ad52ee363e261ffa05ee2438a13/dse_do_utils-0.2.2.2-py2-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "c9d648c12610ba284ee9bfeffefd8dee",
"sha256": "67efff89265cc00a6a82a6475ef2957f1626f0e0143eb4c24967379f0abf5329"
},
"downloads": -1,
"filename": "dse_do_utils-0.2.2.2.tar.gz",
"has_sig": false,
"md5_digest": "c9d648c12610ba284ee9bfeffefd8dee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28071,
"upload_time": "2019-07-09T14:01:15",
"url": "https://files.pythonhosted.org/packages/ab/75/4ff66b6e7057f96b3f716b05f96a11b5f76c562e3bb35658a36b118c9f6e/dse_do_utils-0.2.2.2.tar.gz"
}
],
"0.2.2.3": [
{
"comment_text": "",
"digests": {
"md5": "4b4e76ece7547ed8a6bdb789bd834e86",
"sha256": "5b10f42cc9a6ce817a538487e963beba61eb01056af6159a337c440f3253891a"
},
"downloads": -1,
"filename": "dse_do_utils-0.2.2.3-py2-none-any.whl",
"has_sig": false,
"md5_digest": "4b4e76ece7547ed8a6bdb789bd834e86",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 36398,
"upload_time": "2019-07-10T15:52:22",
"url": "https://files.pythonhosted.org/packages/bb/96/7c36681ce2e92187366e54f989cdbdabb34ace021840930d5be0a770210d/dse_do_utils-0.2.2.3-py2-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "639a3b7cfeb2a6e848089bc5bb6d2ce5",
"sha256": "0c65033215c2694ec8bcf773d40c04ed0437411f1c976f1fb043c10fb537eca5"
},
"downloads": -1,
"filename": "dse_do_utils-0.2.2.3.tar.gz",
"has_sig": false,
"md5_digest": "639a3b7cfeb2a6e848089bc5bb6d2ce5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28562,
"upload_time": "2019-07-10T15:52:23",
"url": "https://files.pythonhosted.org/packages/f4/0f/efa942b3453dd1782f1c95064a05107b1e7adee80f40fb5697bd01d499e1/dse_do_utils-0.2.2.3.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "4b4e76ece7547ed8a6bdb789bd834e86",
"sha256": "5b10f42cc9a6ce817a538487e963beba61eb01056af6159a337c440f3253891a"
},
"downloads": -1,
"filename": "dse_do_utils-0.2.2.3-py2-none-any.whl",
"has_sig": false,
"md5_digest": "4b4e76ece7547ed8a6bdb789bd834e86",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 36398,
"upload_time": "2019-07-10T15:52:22",
"url": "https://files.pythonhosted.org/packages/bb/96/7c36681ce2e92187366e54f989cdbdabb34ace021840930d5be0a770210d/dse_do_utils-0.2.2.3-py2-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "639a3b7cfeb2a6e848089bc5bb6d2ce5",
"sha256": "0c65033215c2694ec8bcf773d40c04ed0437411f1c976f1fb043c10fb537eca5"
},
"downloads": -1,
"filename": "dse_do_utils-0.2.2.3.tar.gz",
"has_sig": false,
"md5_digest": "639a3b7cfeb2a6e848089bc5bb6d2ce5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28562,
"upload_time": "2019-07-10T15:52:23",
"url": "https://files.pythonhosted.org/packages/f4/0f/efa942b3453dd1782f1c95064a05107b1e7adee80f40fb5697bd01d499e1/dse_do_utils-0.2.2.3.tar.gz"
}
]
}