Ontology.NET

A library to work with ontologies and ontology-related file formats.

Documentation

A large documentation page is in preperation at the moment.

Small usage instructions, examples and code snippets can be found under the README.md files for every project/subproject:

• ControlledVocabulary
• Ontology
• OBO
• Ontology Extensions

Contributing

Every contribution is welcome, such as:

• Bug reports
• Feature requests
• Documentation improvement requests
• Typo fixes
• Performance discussions and improvements
• New algorithm implementations
• etc.

Please start by opening an issue.

Check the Development section for general guidance on the codebase

Pull Requests should target the main branch from a forked version of the repo.

This is an open source project created as the result of scientific teaching and research efforts. Please refrain from unrealistic expectations from maintainers.

Development

General

The Ontology.NET repository follows this structure:

root
│   📄<project name>.sln
│   📄build.cmd
│   📄build.sh
├───📁build
├───📁src
|   └───📁<project name>
└───tests
    └───📁<testproject name>

• .sln is the root solution file.
• build contains a FAKE build project with targets for building, testing and packaging the project.
• build/sh and build.cmd in the root are shorthand scripts to execute the build project.
• docs contains the documentation in form of literate scripts and notebooks.
• src contains folders with the source code of the project(s).
• tests contains folders with test projects.

Build

Just call build.sh or build.cmd depending on your OS.

Test

build.sh runtests

build.cmd runtests

Create Nuget package

build.sh pack

build.cmd pack

For prereleases use

build.sh packprerelease

build.cmd packprerelease

Update release notes

build.sh releasenotes <arguments>

build.cmd releasenotes <arguments>

where <arguments> can be:

• semver:<version> where <version> can be major, minor or patch. The respective version part is raised by +1.
• pre:<previewName> where <previewName> is freetext.
• n:<n> where <n> is the number of commits that (shall) belong to the new release. Default is 30.