Merge pull request #2 from mckib2/glpk-from-src

Glpk from src

MANIFEST.in

@@ -1 +1,2 @@
 include requirements.txt
+graft glpk-4.65

README.rst

@@ -12,12 +12,14 @@ Should be an easy pip installation:
 
    pip install scikit-glpk
 
+A Python-compatible C compiler is required to build GLPK from source.
+
 Usage
 -----
 
 There are a few things in this package:
 
-- `glpk()` : the wrappers over the solvers (basically acts like Pythonized `glpsol`)
+- `glpk()` : the wrappers over the solvers (basically acts like Python-friendly `glpsol`)
 - `mpsread()` : convert an MPS file to some matrices
 
 
@@ -46,23 +48,8 @@ Notice that `glpk` is the wrapper and `GLPK` acts as a namespace that holds cons
 GLPK stuffs
 -----------
 
-GLPK must be installed in order to use the wrappers. Download the latest version from `here <http://ftp.gnu.org/gnu/glpk/>`_ and follow the instructions for installation.  If you use Linux/Mac, you should be able to run the following to compile from source (see docs for different configuration options):
-
-.. code-block::
-
-   ./configure
-   make -j
-   make install
-
-For Windows you will need at least `Visual Studio Build Tools <https://visualstudio.microsoft.com/visual-cpp-build-tools/>`_.  Go to the correct subdirectory (w32 for 32-bit or w64 for 64-bit) and the run the batch script:
-
-.. code-block::
-
-   Build_GLPK_with_VC14_DLL.bat
-
-To use the GLPK installation, either provide the location of the shared library to the function, i.e. `glpk(..., libpath='path/to/libglpk.so')` or set the environment variable `GLPK_LIB_PATH=path/to/libglpk.so`.  The wrappers have nothing to wrap if they don't know where to find the library.
+GLPK is installed with the module and a `linprog`-like wrapper is provided with a ctypes backend.  A pared-down version of glpk-4.65 is vendored from `here <http://ftp.gnu.org/gnu/glpk/>`_ and compile instructions are scraped from the makefiles.  I'll try my best to support cross-platform pip installations.
 
-If you already have `Octave <https://www.gnu.org/software/octave/>`_ installed, note that GLPK is bundled with the installation, so you can find `libglpk.[so|dll]` in the `bin` directory and do not have to install it from source as above.
 
 Background
 ----------
@@ -83,7 +70,7 @@ Note that there are several projects that aim for something like this, but which
 - `swiglpk <https://github.com/biosustain/swiglpk>`_ : GPL licensed, low level
 - `optlang <https://github.com/biosustain/optlang>`_ : sympy-like, cool project otherwise
 
-Most existing projects lean to GPL licenses.  Not a bad thing, but would hinder adoption into scipy.
+Most existing projects lean to GPL licenses.  Not a bad thing, but would hinder adoption into scipy (not GLPK itself, but a wrapper to use from within scipy if the user has chosen to install GLPK herself).
 
 Why do we want this?
 --------------------
@@ -95,7 +82,7 @@ Approach
 
 Since the underlying API is quite simple and written in C and only C, `ctypes` is a good fit for this.
 
-GLPK will not be packaged with scipy due to licensing issues, so the strategy will be to specify where the installation is on a user's computer (i.e., path to the shared library).  `linprog` could then presumably route the problem to the GLPK backend instead of HiGHS or the existing native python solvers.
+GLPK is packaged but I may want to make it so the user can optionally specify where the installation is on a user's computer (i.e., path to the shared library) so GLPK is not packaged with `scikit-glpk` and/or scipy.  `linprog` could then presumably route the problem to the GLPK backend instead of HiGHS or the existing native python solvers.
 
 The `ctypes` wrapper is required for integrating GLPK into the Python runtime.  Instead of using MPS files to communicate problems and reading solutions from files, `scipy.sparse.coo_matrix` and `numpy` arrays can be passed directly to the library.  More information can be extracted from GLPK this way as well (For example, there is no way to get iteration count except by reading directly from the underlying structs.  It is only ever printed to stdout, no other way to get it).
 

glpk-4.65/AUTHORS

@@ -0,0 +1,33 @@
+The GLPK package was developed and programmed by Andrew Makhorin,
+Department for Applied Informatics, Moscow Aviation Institute, Moscow,
+Russia.
+
+E-mail:         <[email protected]>
+
+Paper mail:     125871, Russia, Moscow, Volokolamskoye sh., 4,
+                Moscow Aviation Institute, Andrew O. Makhorin
+
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: GnuPG v1.2.2 (MingW32)
+
+mQGiBD8UdT8RBAC6yWYxoa1b7U973J0jBuQpgZnhXlGJJpMZgAW9efDBD17vhkJm
+hPVOQBKRUeOOLcW3/a7NMoNLMdmF1Rgz1FPVy3RgBDsYj4Sp4RBCsX/o0xXh+jxe
+gncr4bdN0Ruk03pezVtLi9oYygdxfI51SsjZ2vwYP6BhMwv+xrIgcnc4qwCgoCit
+26mTd0FoGOmsQuipo6X5LaUD/1l7NqFIjiGdWthyG3TqsiK5Ew7xF3fLEABXKPjb
+PMRTMucX8XXHmW8RUD1vP1uGDnEn6s+fjc3/RtaqKjqGMdLt4XgHQkImaVguNpSS
+IxN3LaK600BgAbwSd1bomRqWNlczAM7469VvGG9ASpCBveUUrqwerHZcUbvngL62
+pIcqA/41dO0xYrOTqMRhuguYMgHL2xbwB2Aj2TqRwBm697DIS25B9nE+8UsbjGRx
+q3EmeuHeZ5kN5RbESXkGUB8whIcYxvH16HRNmM1ZjmFoBVL2Z6S2gpa2ZUqsq7BZ
+s+hriElm3dfOQCt79/o852uKWu5bSjw2yiemVA2T8tG4OoN6DrQjQW5kcmV3IE1h
+a2hvcmluIDxtYW9AbWFpMi5yY25ldC5ydT6IWwQTEQIAGwUCPxR1PwYLCQgHAwID
+FQIDAxYCAQIeAQIXgAAKCRDRe/IwWYHoGKpHAJ44MmzWKr8OiTc0Bb6/RD56aekp
+3wCdGznQMCfWFkehQPbeNaB5yFIs+8a5AQ0EPxR1UBAEAO3U3H5M0iYv06C4kKty
+6ReWyYH4CzMAfp2lPVUKzRSjPtoAJ6SkrBSKMT+U+DahxZ4K4HbinvHq3uvlwWax
+xw0wKxJl4oY6EGE1Jqn3B//Ak47RaNMnrs9V739WT1YNRpQvh4wOCeMekBzksf43
+hm4dSV4PMQkLmrEeG2+BYaZnAAMFA/4tVHhjGRkxzcTcfHCB+Yo3PXeIQMuIs00c
+VKCrNReLni/3BWZC0w9tFzZSdz+URXefPWDGuAC16vLCVOD06NcIQGutPe189dUn
+Kf9Bl6qc9DyWsxSTdF/PbLqcLfEe9g7fHhIwdY+w/hSq2n3NEURMzHiMT1U3CvHd
+As5IzV/yD4hGBBgRAgAGBQI/FHVQAAoJENF78jBZgegYRZEAmwReJkMSrbs0EQs2
+wjyTCMd5KDh3AKCR2/RvVad9RT3ShYnUiPPYTL2/Nw==
+=OfLQ
+-----END PGP PUBLIC KEY BLOCK-----