diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d4f331a..752e5ce8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ - Update tests and testing instructions ([\#14](https://github.com/ubccr/xdmod-data/pull/14)). - Remove limit on number of results returned from `get_filter_values()` ([\#21](https://github.com/ubccr/xdmod-data/pull/21)). - Add a "Feedback / Feature Requests" section to the README ([\#22](https://github.com/ubccr/xdmod-notebooks/pull/22)). +- Document compatibility with different versions of Open XDMoD. ([\#20](https://github.com/ubccr/xdmod-data/pull/20)). ## v1.0.0 (2023-07-21) - Initial release. diff --git a/README.md b/README.md index 0c9263a9..7f02bce4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # xdmod-data -As part of the [XDMoD](https://open.xdmod.org) Data Analytics Framework, this Python package provides API access to the data warehouse of an instance of XDMoD version ≥10.5. +As part of the Data Analytics Framework for [XDMoD](https://open.xdmod.org), this Python package provides API access to the data warehouse of instances of Open XDMoD. The package can be installed from PyPI via `pip install xdmod-data`. @@ -7,6 +7,14 @@ It has dependencies on [NumPy](https://pypi.org/project/numpy/), [Pandas](https: Example usage is documented through Jupyter notebooks in the [xdmod-notebooks](https://github.com/ubccr/xdmod-notebooks) repository. +## Compatibility with Open XDMoD +Specific versions of this `xdmod-data` API are compatible with specific versions of Open XDMoD as indicated in the table below. + +| `xdmod-data` version | Open XDMoD versions | +| -------------------- | ------------------- | +| 1.0.1 | 11.0.x, 10.5.x | +| 1.0.0 | 10.5.x | + ## API Token Access Use of the Data Analytics Framework requires an API token. To obtain an API token, follow the steps below to obtain an API token from the XDMoD portal.