bump version

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.1] - 2024-01-24
+### Added
+- Add multidimensional support in the Python frontend
+
+### Fixed
+- Fix `svSize` indexing.
+
 ## [0.3.0] - 2023.12.27
 ### Added
 - Add class method returning tuple @AdahilMuniz

README.rst

@@ -120,7 +120,13 @@ Here is an example of how to use it in Python:
 
 It is implemented via `py::memoryview`, which offers a mutable view of a raw
 array of any dimension. `pysv` assumes row-major ordering of the underlying
-multi-dimensional array.
+multi-dimensional array. To use multi-dimensional array, use
+``DataType.IntArray[n]``, where ``n`` is the number of dimension, e.g.
+```DataType.IntArray[2]``` creates a 2-D array. Note that due to the usage
+of Python ``memoryview``, only numpy style indexing is supported, e.g.
+``a[1, 2]``. To see more details, please check out the `CPython discussion`_.
+If you don't need to modify the underlying array, you can use ``numpy`` to
+convert the data to a numpy array for further processing.
 
 
 .. _pybind11: https://github.com/pybind/pybind11
@@ -132,4 +138,5 @@ multi-dimensional array.
   :target: https://buildkite.com/stanford-aha/pysv
 .. |PyPI package| image:: https://img.shields.io/pypi/v/pysv?color=blue
   :target: https://pypi.org/project/pysv/
-.. _here: https://pysv.readthedocs.io/index.html
+.. _here: https://pysv.readthedocs.io/index.html
+.. _CPython discussion: https://github.com/python/cpython/issues/67820

setup.py

@@ -18,7 +18,7 @@
 
 setup(
     name='pysv',
-    version='0.3.0',
+    version='0.3.1',
     author='Keyi Zhang',
     author_email='keyi@cs.stanford.edu',
     long_description=long_description,