MiniZinc/minizinc-python

MiniZinc Python

The python package that allows you to access all of MiniZinc's functionalities directly from Python.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
• Getting Started
  • Installation
  • Usage
• Testing
• Roadmap
• Contributing
• License
• Contact

About The Project

MiniZinc Python provides an interface from Python to the MiniZinc driver. The most important goal of this project are to allow easy access to MiniZinc using native Python structures. This will allow you to more easily make scripts to run MiniZinc, but will also allow the integration of MiniZinc models within bigger (Python) projects. This module also aims to expose an interface for meta-search. For problems that are hard to solve, meta-search can provide solutions to reach more or better solutions quickly.

Getting Started

To get a MiniZinc Python up and running follow these simple steps.

Installation

MiniZinc Python can be installed by running pip install minizinc. It requires MiniZinc 2.5.0+ and Python 3.6.0+ to be installed on the system. MiniZinc python expects the minizinc executable to be available on the executable path, the $PATH environmental variable, or in a default installation location.

For more information, please refer to the Documentation

Usage

Once all prerequisites and MiniZinc Python are installed, a minizinc module will be available in Python. The following Python code shows how to run a typical MiniZinc model.

import minizinc

# Create a MiniZinc model
model = minizinc.Model()
model.add_string("""
var -100..100: x;
int: a; int: b; int: c;
constraint a*(x*x) + b*x = c;
solve satisfy;
""")

# Transform Model into a instance
gecode = minizinc.Solver.lookup("gecode")
inst = minizinc.Instance(gecode, model)
inst["a"] = 1
inst["b"] = 4
inst["c"] = 0

# Solve the instance
result = inst.solve(all_solutions=True)
for i in range(len(result)):
    print("x = {}".format(result[i, "x"]))

For more examples, please refer to the Documentation

Testing

MiniZinc Python uses Tox environments to test its coding style and functionality. The code style tests are executed using Black, Flake8, and isort. The functionality tests are constructed using the PyTest unit testing framework.

• To run all tests, simply execute tox in the repository directory.
• Individual environments can be triggered using the -e flag.
  • To test the coding style of the repository run tox -e check
  • The py3x environments are used to test a specific Python version; for example, to test using Python version 3.7 run tox -e py37

Tox can also be used to generate the documentation, tox -e docs, and to typeset the Python code, tox -e format.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Mozilla Public License Version 2.0. See LICENSE for more information.

Contact

👤 Jip J. Dekker

• Twitter: @DekkerOne
• Github: Dekker1

🏛 MiniZinc

• Website: https://www.minizinc.org/