aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: c0d4b7bf620061105af61275b31f28957f320b30 (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
optcut
======

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

`optcut` 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 and single-page web application front-end.


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

* python >=3.6

Additional required python packages are listed in `requirements.txt`.


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

* nodejs >=7
* yarn


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
    * cleanup package.json
    * cleanup webpack.config.js
    * write setup.py

* optimizer

    * evaluate research papers and proposed algorithms
    * define optimizer api
    * implement multiple algorithms in python
    * evaluate python implementations and do native rewrites is needed

* back-end

    * define json schemas and communication interface between back-end and
      front-end
    * basic backend implementation in python
    * additional functionality (multiple output formats)

* front-end

    * implement communication with back-end
    * additional GUI refactoring