tomato-cooker 0.1.0

Minizinc problem solver

Som-MiniZinc

Hackathon held on 11-03-2022 about MiniZinc

This problem was previously solved at https://github.com/Som-Energia/somenergia-tomatic/blob/master/tomatic/backtracker.py. With this library we want to solve the same problem using minizinc language and also open the possibility to extend the resolution of other similar problems.

Prerequisites

Before you begin, ensure you have met the following requirements:

• You must have at least python 3.8. You can get this python version through pyenv. See more here -> https://github.com/pyenv/pyenv#installation
• You should have installed pipenv. Instructions here -> https://pipenv.readthedocs.io/en/latest/#install-pipenv-today
• You should have a Linux/Mac machine. Windows is not supported and we are not thinking in it.
• Optionally, an user with sudo permissions

Installation

pip install git+https://github.com/Som-Energia/Som-Minizinc.git

Usage

import asyncio
from tomato_cooker.grill import GrillTomatoCooker
from tomato_cooker.models import TomaticProblem, tomatic

# define a problem
tomatic_problem_params = {
    "nPersones": 4,
    "nLinies": 2,
    "nSlots": 3,
    "nNingus": 1,
    "nDies": 5,
    "maxTorns": 2,
    "nTorns": [3, 3, 3, 3,],
    "indisponibilitats": [
        {1}, {1}, {2}, {1}, {1},
        {2}, {2}, {2}, {2}, {2},
        {3}, {3}, {2}, {3}, {3},
        {2}, {3}, {2}, {2}, {1},
    ]
}
tomatic_problem = TomaticProblem(**tomatic_problem_params)

# choose a list of minizinc solvers to user
solvers = ["chuffed", "coin-bc"]

# create an instance of the cooker
tomato_cooker = GrillTomatoCooker(tomatic.MODEL_DEFINITION_PATH, solvers)

# Now, we can solve the problem
solution = asyncio.run(tomato_cooker.cook(tomatic_problem))
print(solution)

Contribute

1. Fork the repository on GitHub.
2. Set up your development setup

$> pip install -e .
$> pipenv install --dev

3. Run the tests to confirm they all pass on your system.

$> pipenv run pytest

4. Make your change and run the entire test suite again and confirm that all tests pass including the ones you just added.
5. Create us a GitHub Pull Request to the main repository’s master branch. GitHub Pull Requests are the expected method of code collaboration on this project.

Changes

Historic of changes.

License

This project uses the following license: GNU AFFERO GENERAL PUBLIC LICENSE.