Skip to content

Commit 9acdf4b

Browse files
authored
Update the usage guide (#227)
* New "Ontology management" section that agglomerates several pages. * Updated "Included ontologies" page. * Dedicated page for `pico`. Removed related content from "Utilities" page. * Updated "Working with ontologies" page and renamed to "Ontology packages". * Moved supported ontology languages and formats to a new dedicated page. * Removed YAML ontology format documentation, as it is not longed supported. * Removed "Introduction to ontologies" section. * Moved all pages from the "Working with Ontologies" sections to the usage guide. * Changed title "Supported languages" to "supported formats" on supported_formats.md * Remove the "Detailed design" section * Update panels on the main page * Replace ontology_interface.ipynb with terminological_knowledge.ipynb * Replace cuds_api.ipynb with assertional_knowledge.ipynb * Replace utils.md with visualization.ipynb (just a placeholder for now). * Create dedicated section for sessions. * Add introductory page to sessions. * Add page on managing the session contents. * Add page on queries using the session object. * Add page on queries using the search module (WIP). * Add page on queries using SPARQL (placeholder). * Rename the import/export tutorial to RDF Import and export (no other changes yet). * Remove sessions_and_vars.ipynb * Remove multiple_wrappers.ipynb * Create dedicated section for wrappers. * Rename existing page to be the introductory page for wrappers (changes yet to be done). * Move SimLAMMPS and Quantum Espresso wrapper pages. * Add placeholder pages for wrappers included with SimPhoNy. * Add page on queries using the search module. * Add page on queries using SPARQL. * Adapt the import/export tutorial to SimPhoNy v4. * Add introduction (wrappers section). * Fill SQLite wrapper page. * Fill SQLAlchemy wrapper page. * Fill Dataspace wrapper page. * Fill Remote wrapper page. * Remove Quantum Espresso tutorial. * Remove SimLAMMPS tutorial. * Hide the wrapper development tutorials (to be reincorporated later). * Add visualization section.
1 parent b301826 commit 9acdf4b

32 files changed

Lines changed: 9969 additions & 4991 deletions

docs/detailed_design.md

Lines changed: 0 additions & 743 deletions
This file was deleted.

docs/index.md

Lines changed: 24 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,16 @@ SimPhoNy enables:
3636
3737
Core functionalities, wrappers and advanced utilities
3838
39-
```{link-button} jupyter/cuds_api.ipynb
39+
```{link-button} usage/ontologies/index.html
4040
:text: To the usage guides
4141
:classes: btn-outline-primary stretched-link
4242
4343
---
44-
45-
**Working with Ontologies**
46-
47-
Ontology overview, included ontologies, YAML ontologies and ontology querying
48-
49-
```{link-button} ontology_intro.html
50-
:text: To the ontology guides
51-
:classes: btn-outline-primary stretched-link
52-
---
53-
5444
**Wrapper Development**
5545
5646
A deep dive into the wrapper mechanism for developing new wrappers
5747
58-
```{link-button} wrapper_development.html
48+
```{link-button} wrappers/wrapper_development.html
5949
:text: To the wrapper development guides
6050
:classes: btn-outline-primary stretched-link
6151
---
@@ -93,35 +83,34 @@ introduction/quickstart
9383
:caption: Usage Guide
9484
:maxdepth: 2
9585
96-
usage/utils
97-
usage/cuds_api
98-
usage/sessions_and_vars
99-
usage/multiple_wrappers
100-
usage/import_export
101-
usage/simlammps
102-
usage/quantum_espresso
103-
```
86+
usage/ontologies/index
10487
105-
```{toctree}
106-
:hidden: true
107-
:caption: Working with Ontologies
108-
:maxdepth: 2
88+
usage/terminological_knowledge
89+
usage/assertional_knowledge
10990
110-
ontologies/ontology_intro
111-
ontologies/working_with_ontologies
112-
ontologies/ontologies_included
113-
ontologies/ontology_interface
114-
```
91+
usage/sessions/index
11592
116-
```{toctree}
117-
:hidden: true
118-
:caption: Wrapper Development
119-
:maxdepth: 2
93+
usage/wrappers/index
12094
121-
wrappers/wrapper_development_tutorial
122-
wrappers/wrapper_development
95+
usage/visualization
12396
```
12497

98+
# ```{toctree}
99+
100+
# :hidden: true
101+
102+
# :caption: Wrapper Development
103+
104+
# :maxdepth: 2
105+
106+
#
107+
108+
# wrappers/wrapper_development_tutorial
109+
110+
# wrappers/wrapper_development
111+
112+
# ```
113+
125114
```{toctree}
126115
:hidden: true
127116
:caption: API Reference
@@ -136,7 +125,6 @@ api_reference
136125
:maxdepth: 2
137126
138127
contribute
139-
detailed_design
140128
links
141129
license
142130
Data protection <https://www.simphony-project.eu/en/data_protection.html>

0 commit comments

Comments
 (0)