ANL-CEEESA/MIPLearn
1
0
Fork 0
mirror of https://github.com/ANL-CEEESA/MIPLearn.git synced 2025-12-06 09:28:51 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Alinson S. Xavier
2020-04-12 16:50:41 -05:00
parent f552263be1
commit 7b9709735e
13 changed files with 665 additions and 179 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/404.html
View File

@@ -8,7 +8,7 @@
<link rel="/img/favicon.ico">
<link rel="shortcut icon" href="/img/favicon.ico">
<title>MIPLearn</title>

2
docs/about/index.html
View File

@@ -8,7 +8,7 @@
<link rel="../img/favicon.ico">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>About - MIPLearn</title>

2
docs/benchmark/index.html
View File

@@ -8,7 +8,7 @@
<link rel="../img/favicon.ico">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Benchmark - MIPLearn</title>

2
docs/customization/index.html
View File

@@ -8,7 +8,7 @@
<link rel="../img/favicon.ico">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Customization - MIPLearn</title>

6
docs/index.html
View File

@@ -8,7 +8,7 @@
<link rel="img/favicon.ico">
<link rel="shortcut icon" href="img/favicon.ico">
<title>Home - MIPLearn</title>
@@ -268,6 +268,6 @@
</html>
<!--
MkDocs version : 1.0.4
Build Date UTC : 2020-03-17 16:53:29
MkDocs version : 1.1
Build Date UTC : 2020-04-12 21:50:33
-->

2
docs/js/highlight.pack.js
View File

File diff suppressed because one or more lines are too long

2
docs/problems/index.html
View File

@@ -8,7 +8,7 @@
<link rel="../img/favicon.ico">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Problems - MIPLearn</title>

771
docs/search/lunr.js
View File

File diff suppressed because it is too large Load Diff

2
docs/search/search_index.json
View File

File diff suppressed because one or more lines are too long

30
docs/sitemap.xml
View File

@@ -1,33 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
<loc>None</loc>
<lastmod>2020-03-17</lastmod>
<lastmod>2020-04-12</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
</url><url>
<loc>None</loc>
<lastmod>2020-03-17</lastmod>
<lastmod>2020-04-12</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
</url><url>
<loc>None</loc>
<lastmod>2020-03-17</lastmod>
<lastmod>2020-04-12</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
</url><url>
<loc>None</loc>
<lastmod>2020-03-17</lastmod>
<lastmod>2020-04-12</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
</url><url>
<loc>None</loc>
<lastmod>2020-03-17</lastmod>
<lastmod>2020-04-12</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
</url><url>
<loc>None</loc>
<lastmod>2020-03-17</lastmod>
<lastmod>2020-04-12</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
docs/sitemap.xml.gz
View File

Binary file not shown.

8
docs/usage/index.html
View File

@@ -8,7 +8,7 @@
<link rel="../img/favicon.ico">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Usage - MIPLearn</title>
@@ -153,8 +153,10 @@
<h3 id="installation">Installation</h3>
<p>MIPLearn is mainly written in Python, with some components written in Julia. For this
reason, both Python 3.6+ and Julia 1.3+ are required. A mixed-integer solver is also required, and
its Python bindings must be properly installed. Currently supported solvers include CPLEX and
Gurobi. To install MIPLearn, run the following commands: </p>
its Python bindings must be properly installed. Supported solvers are CPLEX and
Gurobi. Optimization problems currently need to be specified in the Pyomo modeling language.
A JuMP interface to the package is currently under development.</p>
<p>To install MIPLearn, run the following commands: </p>
<pre><code class="bash">git clone https://github.com/ANL-CEEESA/MIPLearn.git
cd MIPLearn
make install

7
src/docs/usage.md
View File

@@ -5,8 +5,11 @@
MIPLearn is mainly written in Python, with some components written in Julia. For this
reason, both Python 3.6+ and Julia 1.3+ are required. A mixed-integer solver is also required, and
its Python bindings must be properly installed. Currently supported solvers include CPLEX and
Gurobi. To install MIPLearn, run the following commands:
its Python bindings must be properly installed. Supported solvers are CPLEX and
Gurobi. Optimization problems currently need to be specified in the Pyomo modeling language.
A JuMP interface to the package is currently under development.
To install MIPLearn, run the following commands:
```bash
git clone https://github.com/ANL-CEEESA/MIPLearn.git