A streamlit dashboard for visualizing metrics of capellambse models.
Configure which Capella model is to be taken as the basis for your dashboard with the config.yaml file:
model:
path: PATH_TO_MODEL # for e.g. git+https|ssh://...
entrypoint: PATH_TO_AIRD
revision: nightly # Optional: Defaults to HEAD in capellambse
earlier_model_revision: BL0-Release # Optional for deltas in metrics
# branch names and tags are allowed here
Then make sure to cd into the capellambse_metrics folder before executing the following command:
streamlit run app.py
The dashboard should then be served on localhost:8501.
Read the full documentation on Github pages.
You can install the latest released version directly from PyPI.
pip install capellambse-metrics
To set up a development environment, clone the project and install it into a virtual environment.
git clone https://github.com/ewuerger/capellambse-metrics cd capellambse-metrics python -m venv .venv source .venv/bin/activate.sh # for Linux / Mac .venv\Scripts\activate # for Windows pip install -U pip pre-commit pip install -e '.[docs,test]' pre-commit install
We'd love to see your bug reports and improvement suggestions! Please take a look at our guidelines for contributors for details.
This project is compliant with the REUSE Specification Version 3.0.
Copyright DB Netz AG, licensed under Apache 2.0 (see full text in LICENSES/Apache-2.0.txt)
Dot-files are licensed under CC0-1.0 (see full text in LICENSES/CC0-1.0.txt)