Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
tfarago committed Sep 26, 2017
1 parent fa511d9 commit 5d38d24
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
Syris
=====

*syris* (**sy**\ nchrotron **r**\ adiation **i**\ maging **s**\ imulation) is a
.. image:: https://readthedocs.org/projects/syris/badge/?version=latest
:target: http://syris.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://badge.waffle.io/ufo-kit/syris.png?label=in%20progress&title=In%20Progress
:target: https://waffle.io/ufo-kit/syris
:alt: 'Stories in In Progress'

*Syris* (**sy**\ nchrotron **r**\ adiation **i**\ maging **s**\ imulation) is a
framework for simulations of X-ray absorption and phase contrast dynamic imaging
experiments, like time-resolved radiography, tomography or laminography. It
includes X-ray sources, various sample shape creation possibilities, complex
Expand All @@ -17,10 +25,6 @@ execute the code on graphic cards.
There are numerous examples of how to use *syris* described below which ship
directly with the code. Enjoy!

You can read more about *Concert* in the official `documentation`_.

.. _documentation: https://syris.readthedocs.io/en/latest/


Citation
--------
Expand Down

0 comments on commit 5d38d24

Please sign in to comment.