research/argus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add codecov badge

Browse source
This commit is contained in:
Anand Balakrishnan 2023-10-15 12:29:47 -07:00
parent 63e93f82ce
commit 192bb20380
No known key found for this signature in database
3 changed files with 7 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.rstcheck.cfg Normal file
View file

@ -0,0 +1,3 @@
[rstcheck]
ignore_directives =
include

2
README.md
View file

@ -3,6 +3,8 @@ Argus: Temporal Logic Monitoring Tool
[![PyPI version](https://badge.fury.io/py/argus-temporal-logic.svg)](https://badge.fury.io/py/argus-temporal-logic)
[![codecov](https://codecov.io/gh/anand-bala/argus/graph/badge.svg?token=O2YXQPWTNS)](https://codecov.io/gh/anand-bala/argus)
Argus aims to be a tool to generate monitors for Signal Temporal Logic (STL), and its
different semantics.

35
docs/index.rst
View file

@ -1,36 +1,5 @@
Argus: Temporal Logic Monitoring Tool
=====================================
.. image:: https://badge.fury.io/py/argus-temporal-logic.svg
:target: https://badge.fury.io/py/argus-temporal-logic
Argus aims to be a tool to generate monitors for Signal Temporal Logic (STL), and its
different semantics.
This library is a direct successor of my `signal-temporal-logic
<https://github.com/anand-bala/signal-temporal-logic/>`_ tool, and is inspired by the
following projects:
- `py-metric-temporal-logic`_ is a tool written in pure Python, and provides an elegant
interface for evaluating discrete time signals using Metric Temporal Logic (MTL).
- `RTAMT`_ is a Python library for offline and online
monitoring of STL specifications.
- `Breach`_ and `S-TaLiRo`_ are Matlab toolboxes designed for falsification and
simulation-based testing of cyber-physical systems with STL and MTL specifications,
respectively. One of their various features includes the ability to evaluate the
robustness of signals against STL/MTL specifications.
The goal of this tool is to provide offline and online monitors for Signal Temporal
Logic (STL) and its semantics, focussing on performance and ease of use in controllers
synthesis and analysis (for training and monitoring them).
The project name is inspired from `Argus Panoptes`_.
.. _Argus Panoptes: https://www.britannica.com/topic/Argus-Greek-mythology
.. _py-metric-temporal-logic: https://github.com/mvcisback/py-metric-temporal-logic/
.. _Breach: https://github.com/decyphir/breach
.. _S-TaLiRo: https://sites.google.com/a/asu.edu/s-taliro/s-taliro
.. _RTAMT: https://github.com/nickovic/rtamt
.. include:: ../README.md
:parser: myst_parser.sphinx_
Installing
----------