Installation#

$ pip install xarray-ms

xarray-ms has a minimal set of dependencies. If cubed, dask or zarr support is required for use with xarray, they must be installed separately.

pip install cubed dask[array] distributed zarr

Development#

Create a virtual environment and install with the dev, doc and testing dependencies:

$ virtualenv -p python3.12 /tmp/xms
$ source xms/bin/activate
(xms) $ pip install -e .[dev,doc,testing]

The pre-commit hooks can be manually executed as follows:

(xms) $ pre-commit run -a

Test Suite#

After creating the virtual environment above, run the following command within the xarray-ms source code directory to execute the test suite:

(xms) $ py.test -s -vvv tests/

Documentation#

Run the following command within the doc sub-directory to build the Sphinx documentation

(xms) $ cd doc
(xms) $ make html

Release Process#

For a new version number, say 0.2.0, perform the following operations on the main branch:

  1. Edit doc/source/changelog.rst to reflect the new version.

  2. Run

    $ tbump --dry-run 0.2.0

  3. If 2. succeeds, run

    $ tbump 0.2.0