Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jsimonclark committed Jan 29, 2024
1 parent 022461a commit fdf5f09
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
12 changes: 5 additions & 7 deletions sphinx/about.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
About the Electrochemistry Ontology (ECHO)
About the Battery Ontology
==========================================
.. |DOI| image:: https://zenodo.org/badge/570454941.svg
:target: https://zenodo.org/badge/latestdoi/570454941

The EMMO Electrochemistry Domain Ontology (ECHO) is a semantic resource for the terms and relations needed to describe things, processes, and data in the electrochemistry domain. It can be used to **generate linked data** for the Semantic Web, **comply with the FAIR data guidelines**, support **interoperaility of data** among different systems, and more!
The EMMO Battery Domain Ontology is a semantic resource for the terms and relations needed to describe things, processes, and data in the battery domain. It can be used to **generate linked data** for the Semantic Web, **comply with the FAIR data guidelines**, support **interoperaility of data** among different systems, and more!

ECHO is intended to support researchers, engineers, and developers within the electrochemical
The Battery Ontology is intended to support researchers, engineers, and developers within the electrochemical
communitiy with activities like:

- Incorporating consistent and standardized information into their modeling and simulation activities.
Expand Down Expand Up @@ -58,9 +56,9 @@ The import structure is summarized in the following table:

The onotlogy exists in two forms: (i) the asserted source files and (ii) the pre-inferred version.

The asserted source consists of two files: - ``electrochemistry.ttl``: describes terms and object properties for the electrochemistry domain. - ``electrochemicalquantities.ttl``: describes the quantities related to the electrochemistry domain. It is encapsulated to allow it to be imported by other EMMO domains without needing to import the entire ontology.
The asserted source consists of two files: - ``battery.ttl``: describes terms and object properties for the electrochemistry domain. - ``batteryquantities.ttl``: describes the quantities related to the electrochemistry domain. It is encapsulated to allow it to be imported by other EMMO domains without needing to import the entire ontology.

The pre-inferred ontology runs the reasoner on the source files and their imports and complies them into a `pre-inferred ontology file <inferred_version/electrochemistry-inferred.ttl>`__. This provides a simpler reference for users of the ontology and removes the barrier of needed to run the reasoner themselves.
The pre-inferred ontology runs the reasoner on the source files and their imports and complies them into a `pre-inferred ontology file <inferred_version/battery-inferred.ttl>`__. This provides a simpler reference for users of the ontology and removes the barrier of needed to run the reasoner themselves.

Acknowledgements
~~~~~~~~~~~~~~~~
Expand Down
10 changes: 5 additions & 5 deletions sphinx/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ FAQ Page

<div class="faq-section" itemscope itemtype="https://schema.org/FAQPage">
<details itemprop="mainEntity" itemscope itemtype="https://schema.org/Question">
<summary itemprop="name">What is the Electrochemistry Ontology?</summary>
<summary itemprop="name">What is the Battery Ontology?</summary>
<div itemprop="acceptedAnswer" itemscope itemtype="https://schema.org/Answer">
<p itemprop="text">
A resource for creating semantic linked data related to electrochemical materials, components, cells, and testing data. It is part of the EMMO universe.
A resource for creating semantic linked data related to battery materials, components, cells, and testing data. It is part of the EMMO universe.
</p>
</div>
</details>
<!-- Repeat for each question -->
<details itemprop="mainEntity" itemscope itemtype="https://schema.org/Question">
<summary itemprop="name">What do I use the Electrochemistry Ontology for?</summary>
<summary itemprop="name">What do I use the Battery Ontology for?</summary>
<div itemprop="acceptedAnswer" itemscope itemtype="https://schema.org/Answer">
<p itemprop="text">
This ontology is used mostly for generating linked data in the Semantic Web and complying with the FAIR data guidelines (although it can also do much more!). It provides machine-readable persistent identifiers for terms and semantic relations that help describe how things are related to each other. Terms and elucidations are derived from authoritative sources like the IEC and IUPAC, so you can be sure that your data & metadata are properly annotated.
Expand All @@ -23,15 +23,15 @@ FAQ Page
</details>
<!-- Add more questions as needed -->
<details itemprop="mainEntity" itemscope itemtype="https://schema.org/Question">
<summary itemprop="name">How do I use the Electrochemistry Ontology?</summary>
<summary itemprop="name">How do I use the Battery Ontology?</summary>
<div itemprop="acceptedAnswer" itemscope itemtype="https://schema.org/Answer">
<p itemprop="text">
Most people use the ontology is to annotate the terms in (meta)data schemas. A common and simple way to use the ontology is as a vocabulary in JSON-LD files. Check out our Examples to see how to do it. You can also visit the <a href="https://json-ld.org/playground/" target="_blank" rel="noopener noreferrer">JSON-LD Playground</a> for more detailed information.
</p>
</div>
</details>
<details itemprop="mainEntity" itemscope itemtype="https://schema.org/Question">
<summary itemprop="name">Why shoud I use the Electrochemistry Ontology?</summary>
<summary itemprop="name">Why shoud I use the Battery Ontology?</summary>
<div itemprop="acceptedAnswer" itemscope itemtype="https://schema.org/Answer">
<p itemprop="text">
Get more value from your data and comply with the FAIR guidelines.
Expand Down

0 comments on commit fdf5f09

Please sign in to comment.