Skip to content

Commit bfd0cdc

Browse files
committed
Update documentation based on PR feedback
1 parent 3694205 commit bfd0cdc

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

docs/source/api_overview.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,15 +71,15 @@ example:
7171
dbentry.create()
7272
7373
74-
Conversion of IDSes between DD versions
75-
---------------------------------------
74+
Conversion of IDSs between DD versions
75+
--------------------------------------
7676

7777
IMASPy can convert IDSs between different versions of the data dictionary. This uses the
7878
"non-backwards compatible changes" metadata from the DD definitions. You can explicitly
7979
convert IDSs using :py:func:`imaspy.convert_ids`:
8080

8181
.. code-block:: python
82-
:caption: Convert an IDSs to a different DD version
82+
:caption: Convert an IDS to a different DD version
8383
8484
import imaspy
8585
@@ -114,9 +114,9 @@ Background information
114114

115115
Since IMASPy needs to have access to multiple DD versions it was chosen to
116116
bundle these with the code at build-time, in setup.py. If a git clone of the
117-
data-dictionary/ succeeds the setup tools automatically download saxon and
118-
generate :py:class:`IDSDef.xml` for each of the tagged versions in the DD git
119-
repository. These are then gathered into :py:class:`IDSDef.zip,` which is
117+
Data Dictionary succeeds, the setup tools automatically download saxon and
118+
generate ``IDSDef.xml`` for each of the tagged versions in the DD git
119+
repository. These are then gathered into ``IDSDef.zip``, which is
120120
distributed inside the IMASPy package.
121121

122122
To update the set of data dictionaries new versions can be added to the zipfile.

docs/source/installing.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,25 @@ an installation of `the IMAS Access Layer <https://imas.iter.org/>`_. See
77
(not) require the IMAS Access Layer available.
88

99

10-
Installing on the ITER cluster and EuroFusion gateway
11-
-----------------------------------------------------
10+
IMASPy modules on the ITER cluster and EuroFusion gateway
11+
---------------------------------------------------------
1212

1313
There is a `module` available on the ITER and Eurofusion Gateway clusters, so
14-
you can run
14+
you can run:
1515

1616
.. code-block:: bash
1717
1818
module load IMASPy
1919
20-
Additionally, if you wish to use the MDSPlus backend, you should load
20+
Additionally, if you wish to use the MDSPlus backend, you should load:
2121

2222
.. code-block:: bash
2323
2424
module load MDSplus-Java/7.96.17-GCCcore-10.2.0-Java-11
2525
26+
If you're using a different cluster, please contact your system administrator to see
27+
if IMASPy is available (or can be made available) on the system.
28+
2629

2730
Local installation
2831
------------------

0 commit comments

Comments
 (0)