Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Autonomous Systems to Formal Models (moco)
# MOdel COmpiler (moco)

## Summary overview

This package provides tools to convert the high level representation of an autonomous system (implemented using a combination of BT XML + a ROS flavoured set of SCXML (also called ROS-SCXML) files) to a formal model (i.e. RoAML).
This package provides tools to convert a RoaML model system description to a lower-level, plain SCXML representation that can be used in model checking tools.
Examples of such tools are [MOON](https://github.com/convince-project/moon) and [SCAn](https://github.com/convince-project/scan).

## Documentation

Please access the documentation via [convince-project.github.io/moco](https://convince-project.github.io/moco)
Please access the documentation at [nevertools.github.io/MOCO](https://nevertools.github.io/MOCO)

## Further Information

Expand All @@ -16,8 +17,8 @@ See [Contributing](./CONTRIBUTING.md).

### Feedback

Feedback is highly appreciated. Please open issues on new ideas, bugs, etc. here at [moco/issues](https://github.com/convince-project/moco/issues) or reach out to the maintainers.
Feedback is highly appreciated. Please open issues on new ideas, bugs, etc. at [moco/issues](https://github.com/nevertools/moco/issues) or reach out to the maintainers.

### License

moco comes under the Apache-2.0 license, see [LICENSE](./LICENSE).
MOCO comes under the Apache-2.0 license, see [LICENSE](./LICENSE).
7 changes: 3 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# Build documentation

Before you can build the documentation, you need to install the required packages as described, since the code API documentation of those packages is also built.
Before you can build the documentation, you need to install MOCO as a package, since the code API documentation of those packages is also built.
From the `docs/` directory, run:

```
pip install ../moco_common
pip install ../roaml_converter
pip install ../roaml_generator
pip install ../
pip install -r requirements.txt
make html
```
36 changes: 18 additions & 18 deletions docs/source/_static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

/* Color variables */
:root {
--convince-orange: #f59d27;
--convince-green: #0e9594;
--convince-pink: #e94667;
--convince-orange-light: #face93;
--convince-green-light: #86cac9;
--convince-pink-light: #f4a2b3;
--convince-orange-dark: #7a4e13;
--convince-green-dark: #074a4a;
--convince-pink-dark: #742333;
--custom-theme-orange: #f59d27;
--custom-theme-green: #0e9594;
--custom-theme-pink: #e94667;
--custom-theme-orange-light: #face93;
--custom-theme-green-light: #86cac9;
--custom-theme-pink-light: #f4a2b3;
--custom-theme-orange-dark: #7a4e13;
--custom-theme-green-dark: #074a4a;
--custom-theme-pink-dark: #742333;
}

/* Side navigation top bit */
Expand Down Expand Up @@ -43,39 +43,39 @@

/* Side bar headers */
.wy-side-nav-title {
background-color: var(--convince-orange);
background-color: var(--custom-theme-orange);
}

/* Headers of boxes */
.rst-content .note .admonition-title, .rst-content .note .wy-alert-title, .rst-content .seealso .admonition-title, .rst-content .seealso .wy-alert-title, .rst-content .wy-alert-info.admonition-todo .admonition-title, .rst-content .wy-alert-info.admonition-todo .wy-alert-title, .rst-content .wy-alert-info.admonition .admonition-title, .rst-content .wy-alert-info.admonition .wy-alert-title, .rst-content .wy-alert-info.attention .admonition-title, .rst-content .wy-alert-info.attention .wy-alert-title, .rst-content .wy-alert-info.caution .admonition-title, .rst-content .wy-alert-info.caution .wy-alert-title, .rst-content .wy-alert-info.danger .admonition-title, .rst-content .wy-alert-info.danger .wy-alert-title, .rst-content .wy-alert-info.error .admonition-title, .rst-content .wy-alert-info.error .wy-alert-title, .rst-content .wy-alert-info.hint .admonition-title, .rst-content .wy-alert-info.hint .wy-alert-title, .rst-content .wy-alert-info.important .admonition-title, .rst-content .wy-alert-info.important .wy-alert-title, .rst-content .wy-alert-info.tip .admonition-title, .rst-content .wy-alert-info.tip .wy-alert-title, .rst-content .wy-alert-info.warning .admonition-title, .rst-content .wy-alert-info.warning .wy-alert-title, .rst-content .wy-alert.wy-alert-info .admonition-title, .wy-alert.wy-alert-info .rst-content .admonition-title, .wy-alert.wy-alert-info .wy-alert-title {
background: var(--convince-green)
background: var(--custom-theme-green)
}

/* Content of boxes */
.rst-content .note, .rst-content .seealso, .rst-content .wy-alert-info.admonition, .rst-content .wy-alert-info.admonition-todo, .rst-content .wy-alert-info.attention, .rst-content .wy-alert-info.caution, .rst-content .wy-alert-info.danger, .rst-content .wy-alert-info.error, .rst-content .wy-alert-info.hint, .rst-content .wy-alert-info.important, .rst-content .wy-alert-info.tip, .rst-content .wy-alert-info.warning, .wy-alert.wy-alert-info {
background: var(--convince-green-light);
background: var(--custom-theme-green-light);
}

/* Boxes in api documentation */
html.writer-html4 .rst-content dl:not(.docutils) > dt, html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) > dt {
background: var(--convince-green-light);
color: var(--convince-green-dark);
border-top: 3px solid var(--convince-green);
background: var(--custom-theme-green-light);
color: var(--custom-theme-green-dark);
border-top: 3px solid var(--custom-theme-green);
padding: 6px;
position: relative;
}

/* All links */
a {
color: var(--convince-pink);
color: var(--custom-theme-pink);
}

/* Links on hover */
a:hover {
color: var(--convince-pink-light);
color: var(--custom-theme-pink-light);
}

/* Visited links */
a:visited {
color: var(--convince-orange);
color: var(--custom-theme-orange);
}
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

# mypy: ignore-errors

project = "CONVINCE Model Checking Components"
copyright = "2025"
author = "CONVINCE Consortium"
project = "MOdel COmpiler"
copyright = "2026"
author = "NeVerTools"

release = "0.1"
version = "0.1.0"
Expand Down
Loading
Loading