diff --git a/README.md b/README.md index 2524940972eb2fb7d42eea6e683a06a9c419e5b2..0c8da1c1175811c5a6def21d76b97842647145dd 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,48 @@ # ADC2018 ---- + A cooperative system using multiple FPGAs for a simple 3D-Numberlink puzzle solver +## Environments + +実際のソルバで使用している環境. + ++ デバイス + - Raspberry Pi 3 B+ + - PYNQ + - ZU3EG + ++ ソフトウェア + - Python >= 3.5 (通信プログラム) + * Flask + * gevent + * gevent-websocket + - Vivado (Web Pack) >= 18.1 (FPGAの合成) + +## Setups + +[Wiki](https://www.togawa.cs.waseda.ac.jp/gitlab/adc2018/adc2018-system/wikis/home)も参照されたい. + +各端末でこのリポジトリをCloneする. + +``` +cd ~ +git clone https://www.togawa.cs.waseda.ac.jp/gitlab/adc2018/adc2018-system.git +``` + +## System + ++ サーバ + - [通信用スクリプト](comm/server) ++ ソルバ + - [通信用スクリプト](comm/client) + - [高位合成用プログラム](hls) ++ リゾルバ + - [通信用スクリプト](comm/resolver) + ## Our previous works * [pynq-router](https://github.com/kotarot/pynq-router) * [nl-solver](https://github.com/kotarot/nl-solver) + +## License +This software is released under GPL v3 License, see [LICENSE](LICENSE). diff --git a/comm/README.md b/comm/README.md index 281c75c94bbaad7a99a2628a26b798eaa430eca0..958814ce65b1e007fa616fb47799408bd51342d7 100644 --- a/comm/README.md +++ b/comm/README.md @@ -1,14 +1,15 @@ -# DAS2017 ADC RaspberryPi・PYNQ間HTTP通信プログラム +# DAS2018 ADC RaspberryPi, ソルバ, リゾルバ HTTP通信プログラム # 概要 -DAS2017アルゴリズムデザインコンテストに向けた,端末間通信プラグラム. -親となるRaspberry Piから,子となる複数のPYNQに対し問題を配信し,結果を受け取る. +DAS2018アルゴリズムデザインコンテストに向けた,端末間通信プラグラム. +親となるRaspberry Piから,子となる複数のソルバ,リゾルバに対し問題を配信し,結果を受け取る. # 構成 -+ server: Raspberry Pi上で実行するためのサーバプラグラム.問題をクライアントに配信し,結果を受け取る. -+ client: PYNQ上で実行するためのクライアントプログラム.問題をサーバから受け取り,問題を解いて回答をサーバに返す. ++ server: Raspberry Pi上で実行するためのサーバプラグラム.問題をソルバに配信し,結果を受け取る. ++ client: ソルバをFPGA上で実行するためのクライアントプログラム.問題をサーバから受け取り,問題を解いて解けたら結果をリゾルバに送り,解けなかったら結果をサーバに報告する. ++ resolver: ソルバから初期解を受け取り,リゾルバでより良い解に整形する. + README.md: このファイル. # Requirements diff --git a/comm/client/README.md b/comm/client/README.md index e15ca83b020b8595bf8e1a57c275587dd3ecaa23..407a9bb552a5cea8a6292e87a1c4b71078d4d5a1 100644 --- a/comm/client/README.md +++ b/comm/client/README.md @@ -1,11 +1,11 @@ -DAS2017 ADC クライアントプログラム +DAS2018 ADC クライアントプログラム === -DAS2017 アルゴリズムデザインコンテスト用クライアントプログラム +DAS2018 アルゴリズムデザインコンテスト用クライアントプログラム ## Description -問題データをサーバから受信し,結果をサーバへ返すプログラム. +問題データをサーバから受信し,結果をリゾルバやサーバへ送るプログラム. ## Requirements @@ -22,7 +22,7 @@ python3 main.py [--port XXXX] [--host XXXX]