diff --git a/broker/README.md b/broker/README.md index bdf21713..9e897395 100644 --- a/broker/README.md +++ b/broker/README.md @@ -15,7 +15,13 @@ Till this happens, it is recommended to go through example files in the [etc/](. ## Setting up a local test for Jungfraujoch For development, it is possible to setup a local installation of Jungfraujoch. This will work without FPGA installed in the computer and allows to test Jungfraujoch software layer, including -ZeroMQ streaming and file writing. There are few necessary steps: +ZeroMQ streaming and file writing. + +The workflow simulates FPGA behavior, by running high-level synthesis code on the CPU - the performance is therefore +very low, as fixed-point calculations have large performance penalty on CPU. In the CPU simulation mode, one can simulate +using only a single FPGA device. + +To run the test: ### Compile Jungfraujoch with frontend ``` @@ -38,6 +44,7 @@ Start writer: cd build/writer ./jfjoch_writer tcp://127.0.0.1:5500 ``` + ### Run tests To run test a Python script is provided: ``` @@ -45,3 +52,7 @@ cd tests/test_data python jfjoch_broker_test.py ``` The script will initialize Jungfraujoch, import test image and start data collection. + +### Expected result +You can observe online data analysis by opening the following web page: [http://localhost:5232](http://localhost:5232). +Also in the `build/writer` subdirectory a dataset with images should be written.