From 9ad2fdab26fda8a8308f788297f08f449622d8db Mon Sep 17 00:00:00 2001 From: bozokopic Date: Mon, 24 Apr 2017 15:39:50 +0200 Subject: README init --- README | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..c0b7955 --- /dev/null +++ b/README @@ -0,0 +1,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 -- cgit v1.2.3-70-g09d2