jinete 0.0.12

High Performance solving suite for the Pickup and Delivery Problem and its related extensions.

jinete

Description

High Performance solving suite for the Pickup and Delivery Problem and its related extensions.

IMPORTANT: This project is still under its early stage of development. So it's not recommended yet to use on real world projects.

This library has been inspired (and created) by a Final Degree Project, which you can read at: https://github.com/garciparedes/tfg-pickup-and-delivery

How to install

pip install jinete

Getting Started

import jinete as jit

file_path = './res/datasets/hashcode/a_example.in'

class MyLoader(jit.FileLoader):
    def __init__(self, *args, **kwargs):
        super().__init__(
            file_path=file_path,
            formatter_cls=jit.HashCodeLoaderFormatter,
            *args, **kwargs,
        )

class MyAlgorithm(jit.InsertionAlgorithm):
    def __init__(self, *args, **kwargs):
        super().__init__(
            crosser_cls=jit.BestStatelessCrosser,
            *args, **kwargs
        )

class MyStorer(jit.PromptStorer):
    def __init__(self, *args, **kwargs):
        super().__init__(
            formatter_cls=jit.ColumnarStorerFormatter,
            *args, **kwargs,
        )

dispatcher = jit.StaticDispatcher(
    MyLoader,
    MyAlgorithm,
    MyStorer,
)

result = dispatcher.run()

# ...

Documentation

You can find the documentation at: https://jinete.readthedocs.io

Development

You can install it simply typing:

pipenv install --dev

To run the tests perform:

pipenv python -m unittest discover tests

Repository Contents

• examples: Basic examples to start using the library.
• jinete: The source code of the library.
  • algorithms: [TODO]
    • exacts: [TODO]
    • heuristics: [TODO]
    • metaheuristics: [TODO]
    • utils: [TODO]
      • crossers: [TODO]
  • dispatchers: [TODO]
  • loaders: [TODO]
    • formatters: [TODO]
  • models: [TODO]
  • storers: [TODO]
    • formatters: [TODO]
• setup.py: The builder of this library.
• tests: The library tests.

LICENSE

This project is licensed under MIT license.