README.rst 2.72 KB
Newer Older
Jerome Hugues's avatar
Jerome Hugues committed
1
Ocarina AADL toolset  |docs| 
yoogx's avatar
yoogx committed
2 3
====================

Jerome Hugues's avatar
Jerome Hugues committed
4 5
Latest release: |release|

Jerome Hugues's avatar
Jerome Hugues committed
6 7
About: 
------
Jerome Hugues's avatar
Jerome Hugues committed
8

Jerome Hugues's avatar
Jerome Hugues committed
9 10 11 12 13
Ocarina is an AADL model processor, it acts as a "compiler" for AADL models.

As a front-end, it supports

* AADLv2 language from `AS5506C standard <http://standards.sae.org/as5506c/>`_, 
Jerome Hugues's avatar
Jerome Hugues committed
14 15
* the Behavioral annex from `AS5506/1 standard <http://standards.sae.org/as5506/a/>`_
* the ARINC653 and the EMV2 annexes from `AS5506/1A standard <http://standards.sae.org/as5506/1a/>`_
Jerome Hugues's avatar
Jerome Hugues committed
16 17 18

As a back-end, it supports

Jerome Hugues's avatar
Jerome Hugues committed
19
* Code generation towards the AADL runtime `PolyORB-HI/Ada <https://github.com/OpenAADL/polyorb-hi-ada>`_ and `PolyORB-HI/C <https://github.com/OpenAADL/polyorb-hi-c>`_, and ARINC653 compliant APEX, following recommendations from `AS5506/2 standard <http://standards.sae.org/as5506/2/>`_
Jerome Hugues's avatar
Jerome Hugues committed
20 21
* WCET analysis, using `Bound-T <http://bound-t.com>`_
* Scheduling analysis, using `Cheddar <http://beru.univ-brest.fr/~singhoff/cheddar/>`_ and `MAST <http://mast.unican.es>`_
Jerome Hugues's avatar
Jerome Hugues committed
22
* Model checking, using Petri Net `Tina <http://projects.laas.fr/tina//>`_, and `LNT <http://cadp.inria.fr>`_
Jerome Hugues's avatar
Jerome Hugues committed
23 24
* Constraint analysis, using the REAL annex language

Jerome Hugues's avatar
Jerome Hugues committed
25 26 27
It can be integrated with the `AADLib <https://github.com/OpenAADL/AADLib>`_ library of AADL components.

It can also be embedded in AADL editors: in `OSATE <http://osate.org>`_ using the `OSATE2 plugin <https://github.com/OpenAADL/osate2-ocarina>`_, and `AADL Inspector <http://www.ellidiss.fr/public/wiki/wiki/inspector>`_
Jerome Hugues's avatar
Jerome Hugues committed
28 29 30 31

Installation:
-------------

Jerome Hugues's avatar
Jerome Hugues committed
32
Refer to the  `ocarina-build <https://github.com/openaadl/ocarina-build>`_ companion project for details.
yoogx's avatar
yoogx committed
33

Jerome Hugues's avatar
Jerome Hugues committed
34 35 36
Q&A:
----

Jerome Hugues's avatar
Jerome Hugues committed
37 38 39 40 41 42 43
+----------------------------------+---------------+
| Build status for Linux and OS X  ||build-status| |
+----------------------------------+---------------+
| Code coverage                    | |coverage|    |
+----------------------------------+---------------+
| CII Best practice                | |cii|         |
+----------------------------------+---------------+
44

45 46 47
.. |build-status| image:: https://travis-ci.org/OpenAADL/ocarina.svg?branch=master 
  :target: https://travis-ci.org/OpenAADL/ocarina

yoogx's avatar
yoogx committed
48 49 50
.. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest
    :alt: Documentation Status
    :scale: 100%
51
    :target: http://ocarina.readthedocs.org/
Jerome Hugues's avatar
Jerome Hugues committed
52 53 54 55

.. |coverage| image:: https://codecov.io/github/OpenAADL/ocarina/coverage.svg?branch=master
  :target: https://codecov.io/gh/OpenAADL/ocarina
  :alt: Code Coverage
Jerome Hugues's avatar
Jerome Hugues committed
56

Jerome Hugues's avatar
Jerome Hugues committed
57 58
.. |release| image:: https://img.shields.io/github/release/OpenAADL/ocarina.svg
  :target: https://github.com/OpenAADL/ocarina/releases
Jerome Hugues's avatar
Jerome Hugues committed
59
  :alt: GitHub Releases
60 61 62 63
  
.. |cii| image:: https://bestpractices.coreinfrastructure.org/projects/1019/badge
  :target: https://bestpractices.coreinfrastructure.org/projects/1019
  :alt: CII Best practice