Metadata-Version: 2.4
Name: rtcvis
Version: 0.3.0
Summary: Tool for visualizing Real Time Calculus (RTC) operations
License: MIT License
        
        Copyright (c) [2025] [Richard Müller]
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Repository, https://github.com/epkRichi/rtcvis
Keywords: math,visualization,education
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: plot
Requires-Dist: matplotlib; extra == "plot"
Requires-Dist: PyQt6; extra == "plot"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Dynamic: license-file

# rtcvis

rtcvis is an educational tool that can create interactive visualizations for convolution operations in the min-plus algebra, such as needed for real time calculus (RTC). RTC is a method for performance analysis of real time systems. Note that rtcvis cannot be used for performance analysis however, since it only supports finite curves - for this purpose, you can use the [RTC toolbox from ETH Zurich](https://www.mpa.ethz.ch/). Please note that I'm in no way affiliated with and that this project is in no way endorsed by ETH Zurich.

## Installation

```shell
pip install rtcvis\[plot\]
```

## Usage

```python
from rtcvis import plot_conv

plot_conv()
```

### Curve Syntax

Curves can be specified using a syntax similar to the one from [RTC toolbox](https://www.mpa.ethz.ch/):

```python
[(x, y, m), ...], l
```

- The first argument is a list of points: `x` and `y` are the coordinates of this points and `m` is the slope of the line section starting at this point
- `l` is the length of the curve, or, in other words, the x coordinate at which the curve ends

Note that Curves are allowed to have discontinuities


## Development

To install the package for development, clone it first and then run

```shell
pip install -e .\[dev,plot\]
pre-commit install
```

To build the package, you can use the build script:

```shell
./build.sh
```
