@@ -35,12 +35,11 @@ Links
35
35
* Issue tracker: https://github.com/INCF/nineml-python/issues
36
36
37
37
38
-
39
38
Relation to the NineML Specification
40
39
------------------------------------
41
40
42
41
The layout of the Python modules and classes in the NineML Python Library
43
- relates closely to the structure of the `NineML specification `_ v1.0. However,
42
+ relates closely to the structure of the `NineML specification `_ ( v1.0) . However,
44
43
there are notable exceptions where the NineML Python Library uses names and
45
44
relationships that are planned to be changed in v2.0 of the specification
46
45
(the NineML Python Library will be backwards compatible), such as the
@@ -54,8 +53,9 @@ provided.
54
53
55
54
In addition to classes that directly correspond to the 9ML object model, a
56
55
range of shorthand notations ("syntactic sugar") exist to make writing 9ML
57
- models by hand more convenient (see the ``nineml.sugar `` module). These notations
58
- are frequently demonstrated in the *examples * directory of the repository.
56
+ models by hand more convenient (see the ``nineml.sugar `` module). These
57
+ notations are frequently demonstrated in the *examples * directory of the
58
+ repository.
59
59
60
60
61
61
The NineML Catalog
@@ -73,26 +73,26 @@ Installation
73
73
HDF5 (dev)
74
74
~~~~~~~~~~
75
75
76
- To add support to read or write HDF5 _ serialisations you must first install a
77
- HDF5 _ dev library (i.e. with headers).
76
+ To add support to read or write HDF5 _ serialisations you must first install
77
+ a HDF5 _ dev library (i.e. with the C headers).
78
78
79
79
On macOS HDF5 _ can be installed using Homebrew _::
80
80
81
81
$ brew install hdf5
82
82
83
- On Ubuntu/Debian HDF5 _ can be installed via the following packages:
83
+ On Ubuntu/Debian HDF5 _ can be installed by one of the following packages:
84
84
85
85
* libhdf5-serial-dev (serial)
86
86
* libhdf5-openmpi-dev (parallel with Open MPI)
87
87
* libhdf5-mpich-dev (parallel with MPICH)
88
88
89
- .. note: If you don't install a HDF5_ other serialisations can
90
- still be used but you will need to install the package manually.
89
+ If you don't install HDF5 _ the other serialisation formats can still be used
90
+ but you will need to install the package manually (i.e. not use * pip *) .
91
91
92
92
Pip
93
93
~~~
94
94
95
- The NineML Python Library can be installed using `` pip `` ::
95
+ The NineML Python Library can be installed using * pip * ::
96
96
97
97
$ pip install nineml
98
98
0 commit comments