Step-by-Step Optimization with Elpee
====================================

.. image:: assets/ElpeeBanner.png
   :alt: Elpee Logo
   :width: 800px
   :align: center


|Version|   |Python Versions|    |Pip Downloads|   |License|   |ReadtheDocs|  |Dependencies|    

**Elpee** (short for **L** inear **P** rogramming) is a Python library for students and academics to viusalize
the steps and iterations required to solve constrained linear optimization problems using linear programming
methods.

Check out the :doc:`usage` section for further information, including
how to :doc:`install` the project.

.. note::

   This project is under active development.

Demo
----

View how linear programming problems can be solved using |Demo|

Contents
--------

.. toctree::
   :maxdepth: 2

   install
   usage
   api

.. |Version| image:: https://img.shields.io/pypi/v/elpee.svg
    :target: https://pypi.org/project/elpee/

.. |Pip Downloads| image:: https://img.shields.io/pypi/dm/elpee.svg?label=PyPI%20downloads
    :target: https://pypi.org/project/elpee/

.. |License| image:: https://img.shields.io/pypi/l/elpee.svg
    :target: https://github.com/pandas-dev/elpee/blob/main/LICENSE

.. |ReadtheDocs| image:: https://img.shields.io/readthedocs/elpee
   :alt: Read the Docs

.. |Dependencies| image:: https://img.shields.io/librariesio/release/pypi/elpee
   :alt: Libraries.io dependency status for latest release

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/elpee
   :alt: PyPI - Python Version

.. |Demo| image:: https://img.shields.io/badge/streamlit-elpee--calc.streamlit.app-red?style=for-the-badge&logo=streamlit
   :target: https://elpee-calc.streamlit.app