Skip to content
This repository has been archived by the owner on Jun 16, 2024. It is now read-only.
/ OKH-LOSH Public archive

A metadata specification to enable the collection of distributed standardised metadata of open source hardware for a graph database (LOSH).

License

Notifications You must be signed in to change notification settings

OPEN-NEXT/OKH-LOSH

Repository files navigation

OKH-LOSH


DEPRECATION WARNING - This repo is now in read-only mode. Please switch over to the new repo: https://github.com/iop-alliance/OpenKnowHow


DOI License REUSE status

In cooperation with Open Source Ecology Germany

LOSH: A Library of Open Source Hardware - technical documentation in an open graph database.

The work here is based on the Open Know-How Specification v1.0.0, as released in 2019. The goal of the adaptations in this repo, is to change the OKHv1 specification to make it applicable to Linked Open data, and rework data fields after latest research results. This fork was proposed to the maintainers of the Open Know-How Specification as a new major version of the specification.

Intro

Who is doing this?

OPEN!NEXT is a collaboration between 19 industry and academic partners across Europe. Funded by the European Union's Horizon 2020 program, this project seeks to enable small and medium enterprises (SMEs) to work with consumers, makers, and other communities in rethinking how products are designed and produced. Open source hardware is a key enabler of this goal where the design of a physical product is released with the freedoms for anyone to study, modify, share, and redistribute copies. These essential freedoms are based on those of open source software, which is itself derived from free software where the word free refers to freedom, not free-of-charge. When put in practice, these freedoms could potentially not only reduce proprietary vendor lock-in, planned obsolescence, or waste but also stimulate novel – even disruptive – business models. The SME partners in OPENNEXT are experimenting with producing open source hardware and even opening up the development process to wider community participation. They produce diverse products ranging from desks, cargo bike modules, to a digital scientific instrument platform (and more).

The work carried out in this repository is subject to WP3 of OPEN!NEXT ("Supporting production engineering with ICT infrastructure") and lead by the department of Information and Process Control at the Fraunhofer Institute for Production Systems and Design Technology.

tl;dr

a distributed database for OSH modules: a demonstrator for a piece of ICT infrastructure to support design reuse

Standards are the backbone for this approach.

short & crisp

We are aiming to build the (real) Internet of Things – the Internet of Open Hardware.

Scope

tl;dr Q&A

What is the domain that the ontology will cover?

Open source hardware modules.
A "module" is defined here as an assembly with a defined purpose. The scope/size of a module is defined by every project individually. On git-based systems, every repository represents exactly one module (except otherwise noted).

Who's the end-user you have in mind?

  1. developers
    the whole thing here is first and foremost about design reuse
  2. manufacturers / service providers
    find OSH published under a free/open license (we perform quality checks) so that you can modify, replicate and exploit OSH products however you like e.g. for cases of decentralised (mass) production, maintenance and service provision – or just for yourself.

What's the problem this thing is solving? Or rather, how does this 'tool' look like?

  1. It's a powerful filter for OSH. Find what you actually need.
  2. It's a knowledge base capable to
    1. answer complex questions like "What development platforms are mainly used among OSH projects that got certified by OSHWA or attested according to DIN SPEC 3105-2?";
    2. cross-link information (e.g. ongoing research with OSH designs (e.g. in case of COVID-19)).

What are use cases of the ontology?

  • find the OSH that solves your problem (→ linking OSH modules with functional categories)
    • filter for license, certificate, functional categories, file formats…
    • e.g. search for corona-related projects
  • provide portable metadata: OSH can be published on various platforms
  • facilitate packaging: essential files can be directly linked in the metadata so:
    • we can run periodic tests to see whether files are still online,
    • you can download those files directly from the LOSH front-end
  • RDF enables custom use cases (e.g. for researchers or other OSH platforms) e.g. by writing custom queries or by linking to other data/knowledge bases, such as Wikidata

Who will use and maintain the ontology?

  1. all the awesome communities that provide the ontology modules we are using, e.g. SPDX
  2. first and foremost: us
  3. this ontology is yet to be presented to the Open Know-How Community; they may choose to endorse this approach as Version 2.0.0 of their specification.

Outlook

We want to organise open source hardware in a graph database.

There's a long list of cool use cases of such a knowledge base. Lots of information (including the technical documentation itself) could be stored as linked open data or simply linked together.

The future could bring e.g.:

  • automated quality & completeness checks for the technical documentation
  • unambiguous reference of all parts (e.g. to a library of standard components or to other OSH)
  • automated matchmaking to manufacturers based on production metadata
  • automated matchmaking with suitable finding opportunities

Technical details

How does the data-flow generally work?

data-flow illustration

Modules used

This standard

Developed and published in this repository here :)

Can I see the ontology structure somewhere?

Our CI automatically generates exports from the TTL source. You can find:

  • Markdown files laying out the structure,
  • GraphViz/DOT graps/diagrams representing the structure,
  • PNG & SVG renders of the graphs/diagrams

Note that when invalid TTL files are pushed, the CI will give back an error and no exports will be available.

Crawler

Frontend

RDF2WB

Want to contribute?

'til we have a proper contribution guide, just join our group on telegram :)

In any case, collaboration in this project must follow our Code of Conduct

Contributor Covenant

Why are we doing this?

"Human history, closely explored, boils down to the history of invention of better tools."
– Ernst Knapp: cultural geographer (1808-1896)