Metadata-Version: 2.1
Name: optconvert
Version: 0.0.1
Summary: Converter for mathematical optimization formats: .mpl, .lp, .xa, .sim, .mpl, .gms, .mod, .xml, .mat.
Home-page: https://github.com/pashtetgp/optconvert
Author: Pavlo Glushko
Author-email: pavloglushko@gmail.com
License: MIT
Download-URL: https://github.com/pashtetGP/optconvert/archive/0.0.1.tar.gz
Description: [![Contributors][contributors-shield]][contributors-url]
        [![Forks][forks-shield]][forks-url]
        [![Stargazers][stars-shield]][stars-url]
        [![Issues][issues-shield]][issues-url]
        [![MIT License][license-shield]][license-url]
        [![LinkedIn][linkedin-shield]][linkedin-url]
        
        
        <!-- PROJECT LOGO -->
        <br />
        <p>
          <a href="https://github.com/pashtetgp/optconvert">
            <img src="https://github.com/pashtetGP/optconvert/raw/master/logo.png" alt="Logo" width="80" height="80">
          </a>
        </p>
        
        
        # OPTCONVERT
        
        Converter for mathematical optimization formats: .mpl, .lp, .xa, .sim, .mpl, .gms, .mod, .xml, .mat.
        
        
        [**Explore the docs**](https://github.com/pashtetgp/optconvert)
        
        
        <!-- <a href="https://github.com/pashtetgp/optconvert">View Demo</a> -->
        [Report Bug](https://github.com/pashtetgp/optconvert/issues)
            -
        [Request Feature](https://github.com/pashtetgp/optconvert/issues)
        
        
        
        <!-- TABLE OF CONTENTS -->
        ## Table of Contents
        
        * [About the Project](#about-the-project)
          * [Built With](#built-with)
        * [Getting Started](#getting-started)
          * [Prerequisites](#prerequisites)
          * [Installation](#installation)
        * [Usage](#usage)
        * [Roadmap](#roadmap)
        * [Contributing](#contributing)
        * [License](#license)
        * [Contact](#contact)
        * [Acknowledgements](#acknowledgements)
        
        
        
        <!-- ABOUT THE PROJECT -->
        ## About The Project
        
        ![CLI example](https://github.com/pashtetGP/optconvert/raw/master/cli_example.png)
        
        Everyone who works with mathematical optimization problems knows what pain in the *** it can be 
        to convert problems from one file format into another. Often ad-hoc solutions for the specific test set
        must be created to read the instances.
        
        This packages provides the unified interface for converting optimization models between popular formats:
        * .mps (incl. smps as three files: .cor, .sto, .tim)
        * .lp ([CPLEX format](http://lpsolve.sourceforge.net/5.1/CPLEX-format.htm))
        * .xa
        * .sim
        * .mpl
        * .gms
        * .mod
        * .xml
        * .mat
        * .c
        
        
        Package can be used as the module in Python or as the command line interface (CLI).
        
        ### Built With
        
        * [Python 3.6](https://www.python.org/)
        * [OptiMax Component Library](http://www.maximalsoftware.com/optimax/)
        
        
        
        <!-- GETTING STARTED -->
        ## Getting Started
        
        To get a local copy up and running follow these simple steps.
        
        ### Prerequisites
        * python 3.6
        * scipy
        * matplotlib
        * wxpython
        * mplpy
        
        ### Installation from PyPI
        1. Install scipy, matplotlib and wxpython
            ```
            pip install scipy, matplotlib, wxpython
            ```
           
        1. Install mplpy
            1. Download and install the [full/academic](http://www.maximalsoftware.com/distrib) or [student](http://www.maximalsoftware.com/download) version of MPL
            1. Install OptiMax Library. On Windows installation file is located in C:\Mplwin\50\setup\Python
        
        1. Install optconvert
            ```
            pip install optconvert
            ```
        
        ### Installation from GitHub repo
        
        1. Install scipy, matplotlib and wxpython
            ```
            pip install scipy, matplotlib, wxpython
            ```
           
        1. Install mplpy
            1. Download and install the [full/academic](http://www.maximalsoftware.com/distrib) or [student](http://www.maximalsoftware.com/download) version of MPL
            1. Install OptiMax Library. On Windows installation file is located in C:\Mplwin\50\setup\Python
            
        1. Clone the repo
            ```
            git clone https://github.com/pashtetgp/optconvert.git
            ```
           
        1. cd to project folder and install the package
            ```
            cd C:\optconvert
            pip install ..\optconvert
            ```
        
        ## Uninstall
        
        run in command line `pip uninstall optconvert`
        
        <!-- USAGE EXAMPLES -->
        ## Usage
        ### As Python module
        See class docstrings for details.
        ```
        from optconvert import Model
        from pathlib import Path
        
        in_file = Path('Dakota_det.mpl')
        model = Model(in_file)
        print('Solution: ' + str(model.solve()))
        out_file = in_file.with_suffix('lp')
        model.export(out_file)
        ```
        
        ### Via CLI
        
        Change the directory to the folder with model files and run ```optconvert```.
        One or multiple files can be converted at once.
        
        ![CLI example](https://github.com/pashtetGP/optconvert/raw/master/cli_example.png)
        <!--_For more examples, please refer to the [Documentation](https://example.com)_-->
        
        CLI mode accepts --file and --out_format arguments
        
        ![CLI example](https://github.com/pashtetGP/optconvert/raw/master/cli_arguments.png)
        
        <!-- ROADMAP -->
        ## Roadmap
        
        See the [open issues](https://github.com/pashtetgp/optconvert/issues) for a list of proposed features (and known issues).
        
        
        
        <!-- CONTRIBUTING -->
        ## Contributing
        
        Any contributions you make are **greatly appreciated**.
        
        1. Fork the Project
        2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
        3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
        4. Push to the Branch (`git push origin feature/AmazingFeature`)
        5. Open a Pull Request
        
        
        
        <!-- LICENSE -->
        ## License
        
        Distributed under the MIT License. See `LICENSE` for more information.
        
        
        
        <!-- CONTACT -->
        ## Contact
        
        Pavlo Glushko
        
        Project Link: [https://github.com/pashtetgp/optconvert](https://github.com/pashtetgp/optconvert)
        
        
        
        <!-- ACKNOWLEDGEMENTS -->
        ## Acknowledgements
        * Icons by [Freepik](https://www.flaticon.com/de/autoren/freepik) from [www.flaticon.com](https://www.flaticon.com/de/)
        * Readme template from [othneildrew](https://github.com/othneildrew/Best-README-Template)
        
        
        
        
        
        
        <!-- MARKDOWN LINKS & IMAGES -->
        <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
        [contributors-shield]: https://img.shields.io/github/contributors/pashtetgp/optconvert.svg?style=flat-square
        [contributors-url]: https://github.com/pashtetgp/optconvert/graphs/contributors
        [forks-shield]: https://img.shields.io/github/forks/pashtetgp/optconvert.svg?style=flat-square
        [forks-url]: https://github.com/pashtetgp/optconvert/network/members
        [stars-shield]: https://img.shields.io/github/stars/pashtetgp/optconvert.svg?style=flat-square
        [stars-url]: https://github.com/pashtetgp/optconvert/stargazers
        [issues-shield]: https://img.shields.io/github/issues/pashtetgp/optconvert.svg?style=flat-square
        [issues-url]: https://github.com/pashtetgp/optconvert/issues
        [license-shield]: https://img.shields.io/github/license/pashtetgp/optconvert.svg?style=flat-square
        [license-url]: https://github.com/pashtetgp/optconvert/blob/master/LICENSE.txt
        [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
        [linkedin-url]: https://linkedin.com/in/pavloglushko
Keywords: converter mathematical optimization mps
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Python: >=3.6
Description-Content-Type: text/markdown
