Skip to content
This repository has been archived by the owner on Sep 4, 2024. It is now read-only.

Capital2/Big-M

Repository files navigation

Contributors Forks Stargazers Issues GPLv3 License


Logo

Big-M

Solving linear programming problems with the Big-M method
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

A uni project with the goal of creating a Big M solver for linear programming problems.

(back to top)

Built With

  • React
  • FastAPI
  • Python

(back to top)

Getting Started

Follow these steps to use the fullstack Big-M.

Our Big M package is available on pypi via

pip install BigM

Prerequisites

if you're going to only use the package Bigm, these steps are optional

  • npm
    npm install npm@latest -g
  • python uvicorn
    pip install uvicorn

Installation

  1. Clone the repo
    git clone https://github.com/Capital2/Big-M.git
  2. Install NPM packages
    npm install
  3. Install python dependencies
    pip install -r requirements.txt

(back to top)

Usage

from BigM import BigM
from BigM import graph
from BigM import InputHandling
import numpy as np

lp = ["Max Z = x+5y","6x+5y<=60","x+2y<=14", "x<=9"]

bm = BigM.BigM()
formattedInput = np.array(InputHandling.formatUserInput(lp))

results = bm.runBigM(formattedInput)

graph.drawGraph(formattedInput, slider=True)

(back to top)

Roadmap

  • Representation with graphs
  • Resolution of R2 and R3 problems

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

Distributed under the GNU/GPLv3 Licence. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/Capital2/Big-M

(back to top)

Acknowledgments

(back to top)