From 3775c3f78002f3ffe70e20944578f7ec3fbfb2be Mon Sep 17 00:00:00 2001 From: "Alinson S. Xavier" Date: Tue, 10 Dec 2024 12:15:24 -0600 Subject: [PATCH] Update docs; fix Sphinx deps; bump to 0.4.2 --- CHANGELOG.md | 2 +- docs/tutorials/getting-started-gurobipy.ipynb | 10 ++-------- docs/tutorials/getting-started-pyomo.ipynb | 10 ++-------- setup.py | 9 +++++++-- 4 files changed, 12 insertions(+), 19 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 391653a..b0ef174 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ 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). -## [0.4.1] - 2024-12-10 +## [0.4.2] - 2024-12-10 ## Changed diff --git a/docs/tutorials/getting-started-gurobipy.ipynb b/docs/tutorials/getting-started-gurobipy.ipynb index 62e5f2c..159d725 100644 --- a/docs/tutorials/getting-started-gurobipy.ipynb +++ b/docs/tutorials/getting-started-gurobipy.ipynb @@ -45,16 +45,10 @@ "- Python version, compatible with the Pyomo and Gurobipy modeling languages,\n", "- Julia version, compatible with the JuMP modeling language.\n", "\n", - "In this tutorial, we will demonstrate how to use and install the Python/Gurobipy version of the package. The first step is to install Python 3.8+ in your computer. See the [official Python website for more instructions](https://www.python.org/downloads/). After Python is installed, we proceed to install MIPLearn using `pip`:\n", + "In this tutorial, we will demonstrate how to use and install the Python/Gurobipy version of the package. The first step is to install Python 3.9+ in your computer. See the [official Python website for more instructions](https://www.python.org/downloads/). After Python is installed, we proceed to install MIPLearn using `pip`:\n", "\n", "```\n", - "$ pip install MIPLearn==0.4\n", - "```\n", - "\n", - "In addition to MIPLearn itself, we will also install Gurobi 10.0, a state-of-the-art commercial MILP solver. This step also install a demo license for Gurobi, which should able to solve the small optimization problems in this tutorial. A license is required for solving larger-scale problems.\n", - "\n", - "```\n", - "$ pip install 'gurobipy>=10,<10.1'\n", + "$ pip install MIPLearn~=0.4\n", "```" ] }, diff --git a/docs/tutorials/getting-started-pyomo.ipynb b/docs/tutorials/getting-started-pyomo.ipynb index 9e2b1e2..72c3517 100644 --- a/docs/tutorials/getting-started-pyomo.ipynb +++ b/docs/tutorials/getting-started-pyomo.ipynb @@ -45,16 +45,10 @@ "- Python version, compatible with the Pyomo and Gurobipy modeling languages,\n", "- Julia version, compatible with the JuMP modeling language.\n", "\n", - "In this tutorial, we will demonstrate how to use and install the Python/Pyomo version of the package. The first step is to install Python 3.8+ in your computer. See the [official Python website for more instructions](https://www.python.org/downloads/). After Python is installed, we proceed to install MIPLearn using `pip`:\n", + "In this tutorial, we will demonstrate how to use and install the Python/Pyomo version of the package. The first step is to install Python 3.9+ in your computer. See the [official Python website for more instructions](https://www.python.org/downloads/). After Python is installed, we proceed to install MIPLearn using `pip`:\n", "\n", "```\n", - "$ pip install MIPLearn==0.4\n", - "```\n", - "\n", - "In addition to MIPLearn itself, we will also install Gurobi 10.0, a state-of-the-art commercial MILP solver. This step also install a demo license for Gurobi, which should able to solve the small optimization problems in this tutorial. A license is required for solving larger-scale problems.\n", - "\n", - "```\n", - "$ pip install 'gurobipy>=10,<10.1'\n", + "$ pip install MIPLearn~=0.4\n", "```" ] }, diff --git a/setup.py b/setup.py index 8d37072..8f1e592 100644 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ from setuptools import setup, find_namespace_packages setup( name="miplearn", - version="0.4.1", + version="0.4.2", author="Alinson S. Xavier", author_email="axavier@anl.gov", description="Extensible Framework for Learning-Enhanced Mixed-Integer Optimization", @@ -36,8 +36,13 @@ setup( "pyflakes==2.5.0", "pytest>=7,<8", "sphinx-book-theme==0.1.0", + "sphinxcontrib-applehelp==1.0.4", + "sphinxcontrib-devhelp==1.0.2", + "sphinxcontrib-htmlhelp==2.0.1", + "sphinxcontrib-serializinghtml==1.1.5", + "sphinxcontrib-qthelp==1.0.3", "sphinx-multitoc-numbering>=0.1,<0.2", - "twine>=4,<5", + "twine>=6,<7", ] }, )