{"id":25636060,"url":"https://opensimulationinterface.github.io/osi-documentation/","last_synced_at":"2026-06-19T15:30:15.415Z","repository":{"id":39700277,"uuid":"206062719","full_name":"OpenSimulationInterface/osi-documentation","owner":"OpenSimulationInterface","description":"This is the official main documentation for the open-simulation-interface organization based on sphinx","archived":false,"fork":false,"pushed_at":"2024-07-15T13:16:09.000Z","size":26880,"stargazers_count":14,"open_issues_count":9,"forks_count":7,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-07-15T18:14:41.872Z","etag":null,"topics":["asam","open-simulation-interface","osi"],"latest_commit_sha":null,"homepage":"","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenSimulationInterface.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-03T11:37:14.000Z","updated_at":"2024-06-26T09:26:26.000Z","dependencies_parsed_at":"2024-06-14T10:02:44.230Z","dependency_job_id":"60c08602-2448-4173-a4fa-8d9b6bf7c6c3","html_url":"https://github.com/OpenSimulationInterface/osi-documentation","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenSimulationInterface%2Fosi-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenSimulationInterface%2Fosi-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenSimulationInterface%2Fosi-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenSimulationInterface%2Fosi-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenSimulationInterface","download_url":"https://codeload.github.com/OpenSimulationInterface/osi-documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240250363,"owners_count":19771780,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asam","open-simulation-interface","osi"],"created_at":"2025-02-23T00:01:57.866Z","updated_at":"2026-06-19T15:30:15.345Z","avatar_url":"https://github.com/OpenSimulationInterface.png","language":"TeX","funding_links":[],"categories":["Data Structures \u0026 Models"],"sub_categories":[],"readme":"= OSI Documentation\n\nThis repo hosts the AsciiDoc-based part of the documentation. \nIt contains generals parts of the content and a CI-pipeline that renders the document with Antora.\n\n// TODO: Update if Asciidoctor is completely dropped!\n\n== ASAM OSI (R) official documentation\n\nSee the documentation https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/index.html[here].\n\n\n== Build pipeline \n// === Asciidoctor pipeline\n\n// The Asciidoctor pipline is no longer active, see Antora pipeline.\n\n// image::https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml/badge.svg[link=https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml]\n\n// The pipeline collects the documentation from both https://github.com/OpenSimulationInterface/open-simulation-interface[open-simulation-interface] and https://github.com/OpenSimulationInterface/osi-sensor-model-packaging[osi-sensor-model-packaging] and integrates it into skeleton of this repo. \n// As with all ASAM Asciidoctor projects, the complete document structure is described in the mapping file https://github.com/OpenSimulationInterface/osi-documentation/blob/master/index.adoc[index.adoc].\n\n=== Antora pipeline \nimage::https://github.com/OpenSimulationInterface/osi-antora-generator/actions/workflows/site-build.yml/badge.svg?branch=main[link=https://github.com/OpenSimulationInterface/osi-antora-generator/actions/workflows/site-build.yml]\n\nNOTE: This pipeline runs on https://github.com/OpenSimulationInterface/osi-antora-generator.\n\n\n== How To build and change documentation locally\n\nIMPORTANT: These instructions relate ONLY to the Asciidoctor build. \nFor Antora, check the https://github.com/OpenSimulationInterface/osi-antora-generator[ASAM OSI Antora generator].\n\n\nThe following instructions show how to build the document locally. \nTake note that the document is built with a version 'localbuild' in the document and filename.\n\nThe instruction should work on Windows, Linux, and MacOS.\n\n. *Precondition*: have docker and docker-compose installed.\n+\nTIP: Official installation can be found https://docs.docker.com/get-docker/[here].\n\n. Clone this repository with submodules. \n+\n[source, shell]\n----\ngit clone https://github.com/OpenSimulationInterface/osi-documentation.git\ngit submodule update --init\n----\n\n. Clone OSI and OSMP with submodules *into* the osi-documentation folder\n+\n[source, shell]\n----\ncd osi-documentation\ngit clone https://github.com/OpenSimulationInterface/open-simulation-interface.git\ngit clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git\n----\n\n. Check file ``docker-compose.yml`` with the following content:\n+\n[source, yaml]\n----\n  version: \"2\"\n  \n  services: \n  asciidoctor:\n      image: asciidoctor/docker-asciidoctor:1\n      volumes: \n      - .:/documents\n      working_dir: /documents\n      entrypoint: asciidoctor -D . --failure-level WARN -r asciidoctor-bibtex -r asciidoctor-diagram -a mathjax --trace --backend=html5 index.adoc -o open-simulation-interface_localbuild.html\n----\n\n. Run \n+\n[source, shell]\n----\ndocker-compose run asciidoctor\n----\n\n. *Result*: Document is build as `open-simulation-interface_localbuild.html` in the folder osi-documentation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/opensimulationinterface.github.io%2Fosi-documentation%2F","html_url":"https://awesome.ecosyste.ms/projects/opensimulationinterface.github.io%2Fosi-documentation%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/opensimulationinterface.github.io%2Fosi-documentation%2F/lists"}