Metadata-Version: 2.4
Name: teaching-optimization
Version: 0.1.1
Summary: Pedagogical material for teaching optimization
Author-email: Michel Bierlaire <michel.bierlaire@epfl.ch>
Project-URL: homepage, http://biogeme.epfl.ch
Project-URL: repository, https://github.com/michelbierlaire/teaching_optimization
Project-URL: download, https://pypi.org/project/teaching-optimization
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: numpy>=2.0.1
Requires-Dist: pandas>=2.2.2
Requires-Dist: scipy>=1.14.0
Requires-Dist: matplotlib>=3.9.1
Requires-Dist: nbformat>=5.10.4
Requires-Dist: networkx>=3.3
Requires-Dist: jupyter>=1.0.0
Provides-Extra: testing
Requires-Dist: pytest>=8.3.1; extra == "testing"
Requires-Dist: pytest-cov>=5.0.0; extra == "testing"
Requires-Dist: tox>=4.16.0; extra == "testing"

# teaching-optimization
[![PyPi](https://img.shields.io/pypi/v/teaching_optimization.svg)](https://pypi.python.org/pypi/teaching_optimization)

Various optimization algorithms used for teaching.

## Script-to-notebook conversion

The project includes a converter for Python teaching scripts. See the
[script conversion guide](https://github.com/michelbierlaire/teaching_optimization/blob/v0.1.1/SCRIPT_CONVERSION_GUIDE.md) for the cell
conventions, explicit markers, docstring behavior, migration examples, and
validation commands.

## Development with uv

Install [uv](https://docs.astral.sh/uv/), then create the locked development
environment and run the tests:

```bash
uv sync --locked
uv run --locked python -m pytest
```

Run the tox matrix when testing the supported Python versions:

```bash
uv run --locked tox
```

Build and validate release artifacts with:

```bash
uv build
uv run --locked twine check dist/*
```
