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

To Do

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.

Source Distribution

ironman-0.5.0.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

ironman-0.5.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file ironman-0.5.0.tar.gz.

File metadata

  • Download URL: ironman-0.5.0.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for ironman-0.5.0.tar.gz
Algorithm Hash digest
SHA256 d87aba809774aba33a23f107f6c5d24afdff9b75577687a4f2a649849ec8ecec
MD5 59fa5a49136fbe4b3ac0c08054b570db
BLAKE2b-256 00d6e57d7369ef7c029eba5c0d25f9239a6092c42287da36e41a34ecec8f0478

See more details on using hashes here.

File details

Details for the file ironman-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: ironman-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for ironman-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c98b29f75d34f7d8f203a3b40aeebe9a67440bc788aa6471519045f5cf221cb8
MD5 c38e7146dd86c1b624b940b35186a312
BLAKE2b-256 c9c99a7258fe9b48207e65a5528d8c0b0f3f6f0e6835d2cbb9be9a1f66230e5f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page