| Name | xpublish-wms JSON |
| Version |
0.9.0
JSON |
| download |
| home_page | None |
| Summary | WMS plugin for xpublish |
| upload_time | 2024-12-09 19:39:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.10 |
| license | Copyright 2017 AUTHOR NAME Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
xarray
xpublish
wms
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
cachey
cartopy
cf_xarray
datashader
matplotlib
mercantile
Pillow
xarray
xpublish
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# xpublish-wms
[](https://pypi.org/project/xpublish-wms/)
[](https://anaconda.org/conda-forge/xpublish-wms)
[](https://github.com/xpublish-community/xpublish-wms/actions/workflows/tests.yml)
[](https://results.pre-commit.ci/latest/github/xpublish-community/xpublish-wms/main)
[Xpublish](https://xpublish.readthedocs.io/en/latest/) routers for the [OGC WMS API](https://www.ogc.org/standards/wms).
## Installation
For `conda` users you can
```shell
conda install --channel conda-forge xpublish_wms
```
or, if you are a `pip` users
```shell
pip install xpublish_wms
```
Once it's installed, the plugin will register itself with Xpublish and WMS endpoints will be included for each dataset on the server.
## Dataset Requirements
At this time, only a subset of xarray datasets will work out of the box with this plugin. To be compatible, a dataset must contain CF compliant coordinate variables for `lat`, `lon`, `time`, and `vertical`. `time` and `vertical` are optional.
Currently the following grid/model types are supported:
- Regularly spaced lat/lon grids (Tested with GFS, GFS Wave models)
- Curvilinear grids (Tested with ROMS models CBOFS, DBOFS, TBOFS, WCOFS, GOMOFS, and CIOFS models)
- FVCOM grids (Tested with LOOFS, LSOFS, LMHOFS, and NGOFS2 models)
- SELFE grids (Tested with CREOFS model)
- 2d Non Dimensional grids (Tested with RTOFS, HRRR-Conus models)
### Supporting new grid/model types
If you have a dataset that is not supported, you can add support by creating a new `xpublish_wms.Grid` subclass and registering it with the `xpublish_wms.register_grid_impl` function. See the [xpublish_wms.grids](/xpublish_wms/grid.py) module for examples.
## Get in touch
Report bugs, suggest features or view the source code on [GitHub](https://github.com/xpublish-community/xpublish-wms/issues).
## License and copyright
xpublish-wms is licensed under BSD 3-Clause "New" or "Revised" License (BSD-3-Clause).
Development occurs on GitHub at <https://github.com/xpublish-community/xpublish-wms>.
## Support
Work on this plugin is sponsored by:
[IOOS](https://ioos.noaa.gov/) ([github](https://github.com/ioos)) funds work on this plugin via the ["Reaching for the Cloud: Architecting a Cloud-Native Service-Based Ecosystem for DMAC"](https://github.com/asascience-open/nextgen-dmac) project being led by [RPS Ocean Science](https://www.rpsgroup.com/).
Raw data
{
"_id": null,
"home_page": null,
"name": "xpublish-wms",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "xarray, xpublish, wms",
"author": null,
"author_email": "Matthew Iannucci <matt@earthmover.io>",
"download_url": "https://files.pythonhosted.org/packages/31/01/e8cd8122917f5f62fb50d9af04b0dc3a33903f49871fa38810b0c297d9bc/xpublish_wms-0.9.0.tar.gz",
"platform": null,
"description": "# xpublish-wms\n\n[](https://pypi.org/project/xpublish-wms/)\n[](https://anaconda.org/conda-forge/xpublish-wms)\n\n[](https://github.com/xpublish-community/xpublish-wms/actions/workflows/tests.yml)\n[](https://results.pre-commit.ci/latest/github/xpublish-community/xpublish-wms/main)\n\n[Xpublish](https://xpublish.readthedocs.io/en/latest/) routers for the [OGC WMS API](https://www.ogc.org/standards/wms).\n\n## Installation\n\nFor `conda` users you can\n\n```shell\nconda install --channel conda-forge xpublish_wms\n```\n\nor, if you are a `pip` users\n\n```shell\npip install xpublish_wms\n```\n\nOnce it's installed, the plugin will register itself with Xpublish and WMS endpoints will be included for each dataset on the server.\n\n## Dataset Requirements\n\nAt this time, only a subset of xarray datasets will work out of the box with this plugin. To be compatible, a dataset must contain CF compliant coordinate variables for `lat`, `lon`, `time`, and `vertical`. `time` and `vertical` are optional.\n\nCurrently the following grid/model types are supported:\n- Regularly spaced lat/lon grids (Tested with GFS, GFS Wave models)\n- Curvilinear grids (Tested with ROMS models CBOFS, DBOFS, TBOFS, WCOFS, GOMOFS, and CIOFS models)\n- FVCOM grids (Tested with LOOFS, LSOFS, LMHOFS, and NGOFS2 models)\n- SELFE grids (Tested with CREOFS model)\n- 2d Non Dimensional grids (Tested with RTOFS, HRRR-Conus models)\n\n### Supporting new grid/model types\n\nIf you have a dataset that is not supported, you can add support by creating a new `xpublish_wms.Grid` subclass and registering it with the `xpublish_wms.register_grid_impl` function. See the [xpublish_wms.grids](/xpublish_wms/grid.py) module for examples.\n\n## Get in touch\n\nReport bugs, suggest features or view the source code on [GitHub](https://github.com/xpublish-community/xpublish-wms/issues).\n\n## License and copyright\n\nxpublish-wms is licensed under BSD 3-Clause \"New\" or \"Revised\" License (BSD-3-Clause).\n\nDevelopment occurs on GitHub at <https://github.com/xpublish-community/xpublish-wms>.\n\n## Support\n\nWork on this plugin is sponsored by:\n\n\n\n[IOOS](https://ioos.noaa.gov/) ([github](https://github.com/ioos)) funds work on this plugin via the [\"Reaching for the Cloud: Architecting a Cloud-Native Service-Based Ecosystem for DMAC\"](https://github.com/asascience-open/nextgen-dmac) project being led by [RPS Ocean Science](https://www.rpsgroup.com/).\n",
"bugtrack_url": null,
"license": "Copyright 2017 AUTHOR NAME Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "WMS plugin for xpublish",
"version": "0.9.0",
"project_urls": {
"Homepage": "https://github.com/xpublish-community/xpublish-wms"
},
"split_keywords": [
"xarray",
" xpublish",
" wms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f2a46755798666f458c0b6d426873d6aecfec1a8bac16c7930a479f75726589c",
"md5": "ee35d7b1e00dc67adc68a932a67c1912",
"sha256": "8591554d944dddeb665dd8cb3b571ea404d318b5db9a1ce71317598a42d8e2b5"
},
"downloads": -1,
"filename": "xpublish_wms-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee35d7b1e00dc67adc68a932a67c1912",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 40937,
"upload_time": "2024-12-09T19:39:18",
"upload_time_iso_8601": "2024-12-09T19:39:18.924500Z",
"url": "https://files.pythonhosted.org/packages/f2/a4/6755798666f458c0b6d426873d6aecfec1a8bac16c7930a479f75726589c/xpublish_wms-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3101e8cd8122917f5f62fb50d9af04b0dc3a33903f49871fa38810b0c297d9bc",
"md5": "f089a07a0734ef901680afe6f1f8a832",
"sha256": "3ddba268df6ffe5f388aae491cd579433446218374e73195b044fe1049f96ae9"
},
"downloads": -1,
"filename": "xpublish_wms-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "f089a07a0734ef901680afe6f1f8a832",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 31362,
"upload_time": "2024-12-09T19:39:20",
"upload_time_iso_8601": "2024-12-09T19:39:20.839264Z",
"url": "https://files.pythonhosted.org/packages/31/01/e8cd8122917f5f62fb50d9af04b0dc3a33903f49871fa38810b0c297d9bc/xpublish_wms-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-09 19:39:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xpublish-community",
"github_project": "xpublish-wms",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "cachey",
"specs": []
},
{
"name": "cartopy",
"specs": []
},
{
"name": "cf_xarray",
"specs": []
},
{
"name": "datashader",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "mercantile",
"specs": []
},
{
"name": "Pillow",
"specs": []
},
{
"name": "xarray",
"specs": []
},
{
"name": "xpublish",
"specs": [
[
"<",
"0.4.0"
],
[
">=",
"0.3.0"
]
]
}
],
"lcname": "xpublish-wms"
}
