ortec.scientific.benchmarks.loadbuilding 1.0.1
Tools for the working with the ORTEC loadbuilding benchmark problems
License: MIT
Requires Python: ~=3.6
Keywords: loadbuilding scientific benchmarks ortec cutting packing


===================================================
 ORTEC scientific benchmark tools for loadbuilding
===================================================

The goal of the `ORTEC Scientific Benchmark platform`__ is to let people work on more practical combinatorial optimization problems. 
In order to allow you to get right to solving them, several Python tools have been developed to view and analyze instances and solutions. 
This package is specific for the loadbuilding benchmark instances and provides in short the following functionality:

* Instance

  * File-type Conversion tool
  * Data Validity Checking tool
  * Find Applicable Constraints and Objectives tool

* Solution

  * File-type Conversion tool
  * Validation tool

* Solution Viewer tool

|
|
|

.. .. figure:: Viewer.png
.. figure:: https://raw.githubusercontent.com/ORTECScientificBenchmarks/ortec-scientific-benchmarks-loadbuilding/master/Viewer.png
   :width: 40 %
   :alt: Solution Viewer
   :align: center
   :figwidth: image

   Screenshot of the Solution Viewer

__ https://benchmarks.ortec.com/


Installation
=============

ORTEC scientific benchmark tools for loadbuilding is published on `PyPI`__ and can be installed from there::

   pip install ortec.scientific.benchmarks.loadbuilding

__ https://pypi.org/project/ortec.scientific.benchmarks.loadbuilding/ 


Documentation
==============

The documentation for these tools as well as the file specifications for the instance and solution files can be downloaded from https://benchmarks.ortec.com/:

* `Tools`_
* `Instances`_
* `Solutions`_

.. _Tools: https://benchmarks.ortec.com/Content/Loadbuilding/Documentation/Tools.pdf
.. _Instances: https://benchmarks.ortec.com/Content/Loadbuilding/Documentation/Instance.pdf
.. _Solutions: https://benchmarks.ortec.com/Content/Loadbuilding/Documentation/Solution.pdf

Release History
================

.. Release 1.0.2.dev
.. ~~~~~~~~~~~~~~~~~
.. 
.. New Features:
.. 
.. * 
.. 
.. Changed:
.. 
.. * 
.. 
.. Fixed:
.. 
.. * 


Release 1.0.1 (2019-03-28)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Changed:

* Improved legend of the solution-viewer, images are now always visible
* Improved help text of the commands
* Improved handling of pallets and boxes
* Improved loading YAML files, stopped the use of deprecated functions
* Improved the (internal) result structure of the solution validation

Fixed:

* Fixed the handling of orientations HLW and WHL, they were switched in the calculations
* Fixed the center of gravity calculation of single items
* Fixed the import of OrderedDict in the strategies to write YAML and JSON solutions


Release 1.0 (2018-05-22)
~~~~~~~~~~~~~~~~~~~~~~~~~~

New Features:

* Added the the following tools:

  * osbl-instance
  * osbl-solution
  * osbl-solution-viewer
  * osbl-find-constraints-objectives


The MIT License (MIT)
=====================

Copyright (c) 2018 ORTECScientificBenchmarks

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.