Metadata-Version: 2.1
Name: exvis
Version: 0.1.0
Summary: exvis visualizes MIP instances based on their expressions (variables and constraints) as a graph.
Project-URL: Homepage, https://github.com/merschformann/exvis
Project-URL: Repository, https://github.com/merschformann/exvis
Author-email: Marius Merschformann <marius.merschformann@gmail.com>
Maintainer-email: Marius Merschformann <marius.merschformann@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Marius Merschformann
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: mip,mixed-integer programming,operations research,optimization,visualization
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.10
Requires-Dist: matplotlib>=3.8.2
Requires-Dist: networkx>=3.2.1
Description-Content-Type: text/markdown

# exvis

exvis **vis**ualizes MIP instances in .mps & .lp format based on their **ex**pressions (variables and constraints) as a graph.

## Installation

```bash
pip install exvis
```

## Usage

```bash
exvis --input data/example/enlight_hard.mps.gz
```

For further options, see `exvis --help`.

## Preview

Shown here are visualizations of instances from the [MIPLIB 2017 set][MIPLIB2017].

| | |
|:-------------------------:|:-------------------------:|
|<img width="1604" alt="enlight_hard" src="data/preview/enlight_hard.mps.gz.light.png"> enlight_hard | <img width="1604" alt="eva1aprime5x5opt" src="data/preview/eva1aprime5x5opt.mps.gz.light.png"> eva1aprime5x5opt |
|<img width="1604" alt="neos-1171737" src="data/preview/neos-1171737.mps.gz.light.png"> neos-1171737 | <img width="1604" alt="neos-1324574" src="data/preview/neos-1324574.mps.gz.dark.png"> neos-1324574 |
|<img width="1604" alt="mine-90-10" src="data/preview/mine-90-10.mps.gz.dark.png"> mine-90-10 | <img width="1604" alt="peg-solitaire-a3" src="data/preview/peg-solitaire-a3.mps.gz.dark.png"> peg-solitaire-a3 |

Many more images of files from the [MIPLIB 2017 set][MIPLIB2017] can be found [here](https://drive.google.com/drive/folders/10xykMGRfd1bMyWigQr8vPto80EeoqU_5?usp=sharing).

## Known issues

- The applied networkx functionality may eat up a lot of memory for large instances or run indefinitely.

[MIPLIB2017]: https://miplib.zib.de/
