Ironman¶
What is Ironman?¶
Ironman is a general purpose software toolbox to be run on L1Calo hardware with embedded processors (SoCs).
Look how easy it is to use
>>> import ironman
>>> # Get your stuff done
>>> ironman.engage()
Features¶
Be awesome
Make things faster
Getting Started¶
Developing¶
If it is your first time…
git clone git@github.com:kratsg/ironman
cd ironman && mkvirtualenv ironman
pip install -r requirements.txt
and then afterwards…
workon ironman
python setup.py develop
... do work here ...
pip uninstall ironman
Contributing¶
Support¶
If you are having issues, let us know.
Releasing¶
Do some work on your package (i.e. fix bugs, add features, etc)
Make sure the tests pass. Run
pytest
.Update the
__version__
number viabump2version
.Push to the default branch.
Tutorial¶
Since we will be predominantly using Twisted within the Zynq to manage the Reactor workflow (“callbacks”), I suggest reading through this tutorial on your own time to get up to speed on how it works and some details of sockets.
I’m following the guide based on sandman
here
To Do¶
split udp and tcp into different, separate protocols: http://stackoverflow.com/questions/33224142/twisted-protocol-that-simultaneously-handles-tcp-and-udp-at-once