Skip to main content

SoC Firmware for L1Calo

Project description

PyPI version Docs

Build Status codecov Code Health

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

Installing

Install ironman by running

pip install ironman

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

Testing

tox

or with

py.test

Contributing

Support

If you are having issues, let us know.

Releasing

  1. Do some work on your package (i.e. fix bugs, add features, etc)
  2. Make sure the tests pass. Run tox (for just tests) tox -e coverage (for tests and coverage)
  3. Update the __version__ number in your package’s **init**.py file
  4. “Freeze” your code by creating a tag: git tag -a x.y.z -m "Your message here..."
  5. Run python setup.py sdist upload to upload the new version of your package to PyPI

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

Ideas

  • make it like twisted.web - we build Request objects which need to find Resource objects that provide actions (maybe too complicated, try and simplify?) link

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ironman, version 0.4.0
Filename, size File type Python version Upload date Hashes
Filename, size ironman-0.4.0-py2-none-any.whl (15.3 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size ironman-0.4.0.tar.gz (13.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page