aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: c0b7955581254925d985a22241664bfbe3df990a (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
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.pip.txt`.


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

* nodejs >=7
* yarn


TODO
----

* global

    * organize build actions using pydoit and webpack
    * create heroku configuration
    * create CONTRIBUTING

* 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

    * create temporary web page
    * implement communication with back-end
    * additional GUI refactoring