Skip to content

Commit

Permalink
Add manifest templates for Linux
Browse files Browse the repository at this point in the history
Signed-off-by: hoangtungdinh <11166240+hoangtungdinh@users.noreply.github.com>
  • Loading branch information
hoangtungdinh committed Aug 21, 2024
1 parent 71d866f commit be4a524
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

This project implements the [ASAM OpenScenario XML Checker](checker_bundle_doc.md).

- [asam-qc-openscenarioxml](#asam-qc-openscenarioxml)
- [Installation and usage](#installation-and-usage)
- [Installation using pip](#installation-using-pip)
- [Installation from source](#installation-from-source)
- [Default Python](#default-python)
- [Poetry](#poetry)
- [Example output](#example-output)
- [Register Checker Bundle to ASAM Quality Checker Framework](#register-checker-bundle-to-asam-quality-checker-framework)
- [Linux Manifest Template](#linux-manifest-template)
- [Tests](#tests)
- [Install using pip](#install-using-pip)
- [Install using poetry](#install-using-poetry)
- [Execute tests](#execute-tests)
- [Contributing](#contributing)


## Installation and usage

asam-qc-openscenarioxml can be installed using pip or from source.
Expand Down Expand Up @@ -95,6 +111,14 @@ asam.net:xosc:0.9.0:is_an_xml_document

```

## Register Checker Bundle to ASAM Quality Checker Framework

Manifest file templates are provided in the [manifest_templates](manifest_templates/) folder to register the ASAM OpenDrive Checker Bundle with the [ASAM Quality Checker Framework](https://github.com/asam-ev/qc-framework/tree/main).

### Linux Manifest Template

To register this Checker Bundle in Linux, use the [linux_manifest.json](manifest_templates/linux_manifest.json) template file. Replace the path to the Python executable `/home/user/.venv/bin/python` in the `exec_command` with the path to the Python executable where the Checker Bundle is installed.

## Tests

To run the tests, you need to install the extra test dependency after installing from source.
Expand Down
10 changes: 10 additions & 0 deletions manifest_templates/linux_manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"module": [
{
"name": "xoscBundle",
"exec_type": "executable",
"module_type": "checker_bundle",
"exec_command": "cd $ASAM_QC_FRAMEWORK_WORKING_DIR && /home/user/.venv/bin/python -m qc_openscenario.main -c $ASAM_QC_FRAMEWORK_CONFIG_FILE"
}
]
}

0 comments on commit be4a524

Please sign in to comment.