Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 2.8 KB

README.md

File metadata and controls

78 lines (52 loc) · 2.8 KB

Roastmaster

PyPI Status Python Version License

Read the documentation at https://roastmaster.readthedocs.io/ Tests Codecov

pre-commit Black

A Python tool backed by PuLP to schedule roast dinners. Specify your dish requirements and oven constraints and output a cooking scheduled optimised for speed and deliciousness.

Features

  • Specify your problem through DishConfig and SystemConfig: cooking times, oven space, etc.
  • Export the solved model as a human-readable recipe.

For a technical description of the model, see [the model documentation](model docs).

Requirements

  • TODO

Installation

You can install Roastmaster via pip from PyPI:

$ pip install roastmaster

Usage

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Roastmaster is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.