sage-numerical-interactive-mip


Namesage-numerical-interactive-mip JSON
Version 0.3.0 PyPI version JSON
download
home_pageNone
SummaryInteractive mixed integer linear programming solver
upload_time2024-11-02 23:29:55
maintainerNone
docs_urlNone
authorPeijun Xiao, Zeyi Wang, Yuan Zhou
requires_pythonNone
licenseGNU General Public License (GPL) v2 or later
keywords milp linear-programming optimization
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =====================================================================================
 sage-numerical-interactive-mip: Interactive mixed integer linear programming solver
=====================================================================================

.. image:: https://github.com/passagemath/sage-numerical-interactive-mip/workflows/Build%20and%20test%20Python%20package/badge.svg
   :alt: [Build and test Python package]
   :target: https://github.com/passagemath/sage-numerical-interactive-mip/actions/

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3627400.svg
   :target: https://doi.org/10.5281/zenodo.3627400

.. intro

This package is an extension of SageMath's mixed integer linear programming
facilities described at
http://doc.sagemath.org/html/en/reference/numerical/index.html

It was written by Peijun Xiao, Zeyi Wang, and Yuan Zhou in 2015-2016 at UC Davis
for integration into SageMath.

Parts of their work (improvements to
``sage.numerical.interactive_simplex_method`` and MIP backend methods)
that required changes to existing SageMath modules have already been
integrated into SageMath in various tickets, see meta-ticket
https://trac.sagemath.org/ticket/20302 (“Interactions with
``InteractiveLinearProgram`` and its dictionaries”).

The module ``sage_numerical_interactive_mip.interactive_milp_problem``,
written by Peijun Xiao, provides the interactive MILP problem classes,
MILP tableau classes, and the cutting plane method. It is based on
commit 5a4e3508d95e95e4491efcb2cf16fbe25be60bec, dated August 24, 2016,
from the SageMath tree https://github.com/pgxiao/cutting-plane-method; 
this work superseded an earlier effort (adding integer variables in
``interactive_simplex_method``) at
https://trac.sagemath.org/ticket/18805

The modules ``sage_numerical_interactive_mip.clean_dictionary`` and
``sage_numerical_interactive_mip.backends.*_backend_dictionary``,
written by Zeyi (Aedi) Wang, provide a textbook view on a simplex basis
in a numerical solver. They are based on
https://trac.sagemath.org/ticket/18804

The branches were rebased by Matthias Koeppe in January 2020 onto
SageMath version 9.1.beta1, then filtered using ``git filter-repo`` and
merged.

How to use
==========

This package uses the modularized distributions of portions of the Sage library
provided by the `passagemath <https://github.com/passagemath/>`_ project.
No installation of SageMath is required.
Just install the package with ``pip``.

The code comes with extensive documentation and tests; see the
docstrings in the modules.

How to run the testsuite and build the HTML documentation
=========================================================

Install ``tox`` with ``pip``, then run ``tox``.

This also builds the documentation in ``.tox/docs/tmp/html/index.html``.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sage-numerical-interactive-mip",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "milp, linear-programming, optimization",
    "author": "Peijun Xiao, Zeyi Wang, Yuan Zhou",
    "author_email": "Matthias Koeppe <mkoeppe@math.ucdavis.edu>",
    "download_url": "https://files.pythonhosted.org/packages/52/b3/09f063738b90e83fa0031fef1b4ad2c5f35010e7c59b17a4cc2d96b0ca3e/sage_numerical_interactive_mip-0.3.0.tar.gz",
    "platform": null,
    "description": "=====================================================================================\n sage-numerical-interactive-mip: Interactive mixed integer linear programming solver\n=====================================================================================\n\n.. image:: https://github.com/passagemath/sage-numerical-interactive-mip/workflows/Build%20and%20test%20Python%20package/badge.svg\n   :alt: [Build and test Python package]\n   :target: https://github.com/passagemath/sage-numerical-interactive-mip/actions/\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3627400.svg\n   :target: https://doi.org/10.5281/zenodo.3627400\n\n.. intro\n\nThis package is an extension of SageMath's mixed integer linear programming\nfacilities described at\nhttp://doc.sagemath.org/html/en/reference/numerical/index.html\n\nIt was written by Peijun Xiao, Zeyi Wang, and Yuan Zhou in 2015-2016 at UC Davis\nfor integration into SageMath.\n\nParts of their work (improvements to\n``sage.numerical.interactive_simplex_method`` and MIP backend methods)\nthat required changes to existing SageMath modules have already been\nintegrated into SageMath in various tickets, see meta-ticket\nhttps://trac.sagemath.org/ticket/20302 (\u201cInteractions with\n``InteractiveLinearProgram`` and its dictionaries\u201d).\n\nThe module ``sage_numerical_interactive_mip.interactive_milp_problem``,\nwritten by Peijun Xiao, provides the interactive MILP problem classes,\nMILP tableau classes, and the cutting plane method. It is based on\ncommit 5a4e3508d95e95e4491efcb2cf16fbe25be60bec, dated August 24, 2016,\nfrom the SageMath tree https://github.com/pgxiao/cutting-plane-method; \nthis work superseded an earlier effort (adding integer variables in\n``interactive_simplex_method``) at\nhttps://trac.sagemath.org/ticket/18805\n\nThe modules ``sage_numerical_interactive_mip.clean_dictionary`` and\n``sage_numerical_interactive_mip.backends.*_backend_dictionary``,\nwritten by Zeyi (Aedi) Wang, provide a textbook view on a simplex basis\nin a numerical solver. They are based on\nhttps://trac.sagemath.org/ticket/18804\n\nThe branches were rebased by Matthias Koeppe in January 2020 onto\nSageMath version 9.1.beta1, then filtered using ``git filter-repo`` and\nmerged.\n\nHow to use\n==========\n\nThis package uses the modularized distributions of portions of the Sage library\nprovided by the `passagemath <https://github.com/passagemath/>`_ project.\nNo installation of SageMath is required.\nJust install the package with ``pip``.\n\nThe code comes with extensive documentation and tests; see the\ndocstrings in the modules.\n\nHow to run the testsuite and build the HTML documentation\n=========================================================\n\nInstall ``tox`` with ``pip``, then run ``tox``.\n\nThis also builds the documentation in ``.tox/docs/tmp/html/index.html``.\n",
    "bugtrack_url": null,
    "license": "GNU General Public License (GPL) v2 or later",
    "summary": "Interactive mixed integer linear programming solver",
    "version": "0.3.0",
    "project_urls": {
        "Homepage": "https://github.com/passagemath/sage-numerical-interactive-mip"
    },
    "split_keywords": [
        "milp",
        " linear-programming",
        " optimization"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "52b309f063738b90e83fa0031fef1b4ad2c5f35010e7c59b17a4cc2d96b0ca3e",
                "md5": "4dc8b17b54075d52a67dbbee1df9aca8",
                "sha256": "ec1e77d0c2aecaec2389958dc2b4aa42ce2d07770a65024fcc19a69cae43e310"
            },
            "downloads": -1,
            "filename": "sage_numerical_interactive_mip-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4dc8b17b54075d52a67dbbee1df9aca8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 66949,
            "upload_time": "2024-11-02T23:29:55",
            "upload_time_iso_8601": "2024-11-02T23:29:55.239728Z",
            "url": "https://files.pythonhosted.org/packages/52/b3/09f063738b90e83fa0031fef1b4ad2c5f35010e7c59b17a4cc2d96b0ca3e/sage_numerical_interactive_mip-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-02 23:29:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "passagemath",
    "github_project": "sage-numerical-interactive-mip",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "sage-numerical-interactive-mip"
}
        
Elapsed time: 0.77888s