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.4.tar.gz (277.9 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.4-py3-none-any.whl (78.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: los_lang-3.3.4.tar.gz
  • Upload date:
  • Size: 277.9 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.4.tar.gz
Algorithm Hash digest
SHA256 ed8922a8b87291cb3576101d6f7ea8c2f94ff97d6d627cad092eb093baf13a2a
MD5 832ea920729555dc3c940d7a03167d6e
BLAKE2b-256 798a7fbdbcec7f4b87615a4efd5aca95a02613b6b972601f9b86190d502fadc4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: los_lang-3.3.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 865b5742139e75385fd93bfdaea42cd1e84e03299ae4e673fbf31ab39817f820
MD5 3988fd2f6ce661794cdfb77016e426c7
BLAKE2b-256 ed985c54c1ffe8bdf642a532dfd2f7a5233369a8c6cb2f4e0015dabe3465f488

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