Skip to content

Commit

Permalink
Docs improvement (#23)
Browse files Browse the repository at this point in the history
* fix spelling mistake in figure link

* fix json file display

* reorder total_flow_rate into results
  • Loading branch information
schumannj authored Oct 15, 2024
1 parent 60ac2bc commit 56fd9fe
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
7 changes: 3 additions & 4 deletions docs/how_to/use_this_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Below you see a fresh instance of a **Catalyst Sample** entry, which can be fill

## The **Catalytic Reaction** schema
Here you see a screenshot of an empty **Catalytic Reaction** measurement entry.
![image of measurement instance for a catalytic reaction](ScreenshotReactionMeasurement.png)
![image of measurement instance for a catalytic reaction](ScreenshotReactionMeasurementEntry.png)

### Populate the CatalyticReaction schema from a data file

Expand Down Expand Up @@ -119,6 +119,7 @@ The following information is currently added by default to entries filled by a h
Another way to generate entries in NOMAD is to place *.archive.json files directly in one upload. The file needs to contain the path to a schema and then NOMAD automatically creates the corresponding entry. The archive.json file does not contain unit information, this is only defined and stored in the schema definition and does not need to correspond to the display unit in the GUI. But usually this is the SI unit of a respective quantity.

```json

{
"data": {
"m_def": "nomad_catalysis.schema_packages.catalysis.CatalyticReaction",
Expand All @@ -141,9 +142,7 @@ Another way to generate entries in NOMAD is to place *.archive.json files direct
"set_pressure": [
101325.0
],
"set_temperature": [

],
"set_temperature": [ ],
"set_total_flow_rate": [ ],
"contact_time": [],
"weight_hourly_space_velocity": [],
Expand Down
3 changes: 2 additions & 1 deletion docs/reference/references.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@


!!! List of quantities and subsections in `Catalyst Sample`:

- name (string quantity)
- datetime (string quantity)
- lab_id (string quantity)
Expand Down Expand Up @@ -86,7 +87,6 @@
- set_temperature
- set_pressure
- set_total_flow_rate
- total_flow_rate
- contact_time (label W|F)
- sampling_frequency
- time_on_stream
Expand All @@ -105,6 +105,7 @@
- name
- temperature
- pressure
- total_flow_rate
- runs
- time_on_stream
- c_balance
Expand Down

0 comments on commit 56fd9fe

Please sign in to comment.