Skip to content

Commit 6ae22a7

Browse files
committed
updates docs
1 parent c09a8f0 commit 6ae22a7

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,20 @@ print('cell value:', m3[tazs[100]][tazs[100]]) # 3.0 (taz (100,100) is cell [99
112112
myfile.close()
113113
```
114114

115+
# Testing
116+
Testing is done with [nose](https://nose.readthedocs.io/en/latest/). Run the tests via:
117+
118+
```
119+
openmatrix\test> nosetests -v
120+
```
121+
122+
# OMX File Validator
123+
Included in this package is a command line OMX file validation tool used to validate OMX files against the specification. The tool is added to the system PATH when the package is installed and can be run as follows:
124+
125+
```
126+
omx-validate my_file.omx
127+
```
128+
115129
# Usage Notes
116130

117131
### File Objects
@@ -181,7 +195,7 @@ A mapping allows rows and columns to be accessed using an integer value other th
181195
## Global Properties
182196

183197
### `__version__`
184-
OMX module version string. Currently '0.3.3' as of this writing. This is the Python API version.
198+
OMX module version string. Currently '0.3.5' as of this writing. This is the Python API version.
185199

186200
### `__omx_version__`
187201
OMX file format version. Currently '0.2'. This is the OMX file format specification that omx-python adheres to.
@@ -212,7 +226,7 @@ OMX file format version. Currently '0.2'. This is the OMX file format specificat
212226
See HDF5 docs for more detail.
213227
shape: numpy.array
214228
Shape of matrices in this file. Default is None. Specify a valid shape
215-
(e.g. (1000,1200)) to enforce shape-checking for all added objects.
229+
(e.g. (1200,1200)) to enforce shape-checking for all added objects.
216230
If shape is not specified, the first added matrix will not be shape-checked
217231
and all subsequently added matrices must match the shape of the first matrix.
218232
All tables in an OMX file must have the same shape.

0 commit comments

Comments
 (0)