aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: 2d16e37561a935522176a5b88b043a39ec55cce5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
opcut
=====

`https://opcut.herokuapp.com/`

`opcut` is cutting stock problem optimizer
(`https://en.wikipedia.org/wiki/Cutting_stock_problem`) utilizing multiple
panels and guillotine cuts (end-to-end cuts). This project includes multiple
back-end optimizer implementations, command line front-end and single-page web
application front-end.


Runtime requirements
--------------------

* python >=3.8


Development requirements
------------------------

* nodejs >=7
* yarn


Install
-------

::

    $ pip install opcut


Run
---

Running server (default listening address http://0.0.0.0:8080)::

    $ opcut server

Running command line utility::

    $ opcut calculate ...

Additional command line arguments::

    $ opcut --help


Build
-----

Build tool used for `opcut` is pydoit (`http://pydoit.org/`). It can be
installed together with other python dependencies by running::

    $ pip install -r requirements.txt

For listing available doit tasks, use::

    $ doit list

Default task::

    $ doit

creates `dist` folder containing `opcut` distribution.


TODO
----

* global

    * create CONTRIBUTING

* optimizer

    * add additional algorithms
    * evaluate python implementations and do native rewrites if needed

* back-end

    * additional output formats