Skip to main content

Write Math, Run Python. A Language for Optimization Specification (LOS).

Project description

LOS — Language for Optimization Specification

License: MIT Python 3.9+ Security: Hardened

LOS is a Language for Optimization Specification. It compiles human-readable model definitions into executable Python/PuLP code, keeping your business logic clean and your data pipeline separate.

"Write Math, Run Python."


Installation

pip install los-lang

Or install from source:

git clone https://github.com/jowpereira/los.git
cd los
pip install -e .

Quick Start

1. Write a Model (production.los)

import "products.csv"
import "factories.csv"

set Products
set Factories

param Cost[Products]
param Capacity[Factories]

var qty[Products, Factories] >= 0

minimize:
    sum(qty[p,f] * Cost[p] for p in Products, f in Factories)

subject to:
    capacity_limit:
        sum(qty[p,f] for p in Products) <= Capacity[f]
        for f in Factories

2. Prepare Data

products.csv

Products,Cost
WidgetA,10
WidgetB,15

factories.csv

Factories,Capacity
Factory1,1000
Factory2,2000

3. Solve (solve.py)

import los

result = los.solve("production.los")

if result.is_optimal:
    print(f"Optimal Cost: {result.objective}")
    print(result.get_variable("qty", as_df=True))

Why LOS?

Feature LOS Raw PuLP/Pyomo
Readability Whiteboard-like syntax Python boilerplate
Data Binding Native CSV imports Manual DataFrame wrangling
Security Sandboxed execution Full Python access
Debug Inspect generated code (model.code()) Black box
Solver CBC, GLPK, Gurobi, CPLEX (via PuLP) Same

Advanced: Manual Data Binding

For dynamic data (APIs, databases), inject DataFrames directly:

import los
import pandas as pd

df = pd.DataFrame({"Products": ["A", "B"], "Cost": [10, 20]})

result = los.solve("model.los", data={"Products": df})

Documentation

Document Description
User Manual Full syntax reference and API guide
Security Policy Sandbox details and threat model
Changelog Version history
Contributing How to contribute

License

MIT © Jonathan Pereira

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

los_lang-3.3.3.tar.gz (277.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

los_lang-3.3.3-py3-none-any.whl (78.0 kB view details)

Uploaded Python 3

File details

Details for the file los_lang-3.3.3.tar.gz.

File metadata

  • Download URL: los_lang-3.3.3.tar.gz
  • Upload date:
  • Size: 277.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for los_lang-3.3.3.tar.gz
Algorithm Hash digest
SHA256 ae89baac0056d70855ce4940214dbf033613f5547647897e8dc723668f255e67
MD5 a01753fce1e8a826bb2f20a79ea3381a
BLAKE2b-256 90f11bd00764982c8dbd230eef99c08a9c066f225f3375dad61232a620e301bb

See more details on using hashes here.

File details

Details for the file los_lang-3.3.3-py3-none-any.whl.

File metadata

  • Download URL: los_lang-3.3.3-py3-none-any.whl
  • Upload date:
  • Size: 78.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for los_lang-3.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1ced19d82650a1d5bc643c435409a342979e650ec6ebe7817f9433397012183b
MD5 de5608bb2d0e891bd4a3710550d18c92
BLAKE2b-256 c521bb09353367eca6f2be1d0c86cd33b483853a5f85cae84d7dc9ed9971e6e6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page