Skip to content

Commit

Permalink
Doc: Extended introduction and linked Objects page of Knowledge Website
Browse files Browse the repository at this point in the history
  • Loading branch information
malte3d committed Sep 20, 2023
1 parent 191259b commit 33fe1d6
Showing 1 changed file with 24 additions and 11 deletions.
35 changes: 24 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,15 @@
[![Build and Test](https://github.com/SUTURO/Owl2Anything/actions/workflows/build-and-test.yml/badge.svg?branch=main)](https://github.com/SUTURO/Owl2Anything/actions/workflows/build-and-test.yml) [![Release (latest SemVer)](https://img.shields.io/github/v/release/SUTURO/Owl2Anything)](https://github.com/SUTURO/Owl2Anything/releases)

The [SUTURO](https://github.com/suturo) Owl2Anything Converter is a Java-based tool that can be used to convert OWL
ontology
files into other formats like CSV and JSON. It can
be used to extract information from an ontology and export it into a tabular or annotation format, which can be easily
imported into
other tools or used for analysis.
ontology files into other formats like CSV and JSON.

It can be used to extract information from an ontology and export
it into a tabular or annotation format, which can be easily imported into other tools or used for analysis. One of the
main features of the converter is the ability to export relevant information from the ontology into a CSV
file, which can be used to easily display the ontology in a searchable table format.

Examples of the exported formats can be found in the Downloads section of the Objects page of
the [SUTURO Knowledge website](https://suturo.github.io/suturo_knowledge/objects/).

## Requirements

Expand All @@ -25,8 +29,10 @@ The options are described below:
- `-i`, `--input`: Path to the input ontology file in OWL format (required).
- `-r`, `--root`: IRI of the root class. Every sublass of this IRI will be exported. (required).
- `-m`, `--mapping`: Path to the IRI mapping file (optional). If not specified, the default SUTURO IRI mapping will be used.
- `-n`, `--namespaces`: Path to the IRI namespaces file (optional). If not specified, the default SUTURO IRI namespaces will be used.
- `-m`, `--mapping`: Path to the IRI mapping file (optional). If not specified, the default SUTURO IRI mapping will be
used.
- `-n`, `--namespaces`: Path to the IRI namespaces file (optional). If not specified, the default SUTURO IRI namespaces
will be used.
The IRI mapping file is a CSV file that maps (invalid) ontology IRIs to replacements. The file should have the
following format:
Expand All @@ -49,14 +55,17 @@ http://www.ease-crc.org/ont/SOMA.owl#;soma
### Recommend Code Editor
We recommend using [IntelliJ IDEA](https://www.jetbrains.com/idea/) as code editor for this project with the following plugins:
We recommend using [IntelliJ IDEA](https://www.jetbrains.com/idea/) as code editor for this project with the following
plugins:
- Lombok
### Getting Started
1. Open the project in IntelliJ IDEA
2. Place the `suturo.owl` file in the projects root folder
3. Execute the Run-Configuration `Run Owl2Anything` or start the application via the main method in `Owl2Anything.java` with the required arguments.
3. Execute the Run-Configuration `Run Owl2Anything` or start the application via the main method in `Owl2Anything.java`
with the required arguments.
4. The generated files will be placed in the `owl2anything/output` folder
### Create a Release
Expand All @@ -65,6 +74,7 @@ To publish a new release, you need to create a new tag with the version number a
The release is then published automatically by the GitHub Actions [release.yml](.github/workflows/release.yml) workflow.
Example:
```bash
git tag -a 1.3.0 -m "v1.3.0" -m "- Fix bug in CSV export"
git push origin 1.3.0
Expand All @@ -74,8 +84,11 @@ git push origin 1.3.0
- The tag message head should start with a `v` prefix and then the tag name (e.g. `v1.3.0`).
- The tag message body should contain a short description of the changes since the last release.
To use the new release, change the `OWL2ANYTHING_VERSION` in the [owl2anything.yml](https://github.com/SUTURO/suturo_knowledge/blob/master/.github/workflows/owl2anything.yml) workflow of the [Knowledge Project](https://github.com/SUTURO/suturo_knowledge).
To use the new release, change the `OWL2ANYTHING_VERSION` in
the [owl2anything.yml](https://github.com/SUTURO/suturo_knowledge/blob/master/.github/workflows/owl2anything.yml)
workflow of the [Knowledge Project](https://github.com/SUTURO/suturo_knowledge).
## License
The SUTURO Owl2Anything Converter is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.
The SUTURO Owl2Anything Converter is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for
details.

0 comments on commit 33fe1d6

Please sign in to comment.