| Name | meshiphi JSON |
| Version |
2.1.15
JSON |
| download |
| home_page | None |
| Summary | MeshiPhi: Earth's digital twin mapped on a non-uniform mesh |
| upload_time | 2024-11-06 16:02:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2022 British Antarctic Survey Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
polar science
geospatial
marine science
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Meshiφ (MeshiPhi)
<!-- <a href="https://colab.research.google.com/drive/12D-CN10X7xAcXn_df0zNLHtdiiXxZVkz?usp=sharing"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" alt="Colab"> -->
<a href="https://antarctica.github.io/MeshiPhi/"><img src="https://img.shields.io/badge/Manual%20-github.io%2FMeshiPhi%2F-red" alt="Manual Page"></a>
<a href="https://pypi.org/project/meshiphi/"><img src="https://img.shields.io/pypi/v/meshiphi" alt="PyPi"></a>
<a href="https://github.com/antarctica/meshiphi/tags"><img src="https://img.shields.io/github/v/tag/antarctica/MeshiPhi" alt="Release Tag"></a>
<a href="https://github.com/antarctica/MeshiPhi/issues"><img src="https://img.shields.io/github/issues/antarctica/MeshiPhi" alt="Issues"></a>
<a href="https://github.com/antarctica/MeshiPhi/blob/main/LICENSE"><img src="https://img.shields.io/github/license/antarctica/MeshiPhi" alt="License"></a>
Introducing Meshiφ, a versatile software package designed for comprehensive earth modeling and navigation planning. Meshiφ works by discretizing the Earth's surface into a non-uniform grid, allocating higher resolution in regions of geographic diversity, and conserving lower resolution in more uniform regions. The software also incorporates data-driven vehicle models, with the ability to calculate speed limits and fuel needs for specific vessels within each grid cell. These mesh objects can be output in standard formats, such as GeoJSON and GeoTIFF, enabling data-visualisation via GIS software such as ArcGIS.
## Installation
Meshiφ can be installed via pip or by cloning the repository from GitHub.
Pip:
```
pip install meshiphi
```
Github: (for local development)
```
git clone https://github.com/Antarctica/MeshiPhi
cd MeshiPhi
pip install -e .
```
The Meshiφ package has an optional dependency on GDAL, which is required to produce outputs in GeoJSON or GeoTIFF formats. More information on setting up GDAL can be found in the manual pages linked above. Once these requirements are met then the software can be installed by:
> NOTE: The installation process may vary slightly dependent on OS. Please consult the documentation for further installation guidance.
## Documentation
Sphinx is used to generate documentation for this project. The dependencies can be installed through pip:
```
pip install sphinx sphinx_markdown_builder sphinx_rtd_theme rinohtype
```
When updating the docs, run the following command within the MeshiPhi directory to recompile.
```
sphinx-build -b html ./docs/source ./docs/html
```
Sometimes the cache needs to be cleared for internal links to update. If facing this problem, run this from the MeshiPhi directory.
```
rm -r docs/build/.doctrees/
```
## Required Data sources
Meshiφ has been built to work with a variety of open-source atmospheric and oceanographic data sources.
A list of supported data sources and their associated data-loaders is given in the
'Data Loaders' section of the manual
## Developers
Samuel Hall, Harrison Abbot, Ayat Fekry, George Coombs, Jonathan Smith, Maria Fox, and James Byrne
## Collaboration
We are currently assessing the best practice for collaboration on the codebase, until then please contact [polarroute@bas.ac.uk](polarroute@bas.ac.uk) for further info.
## License
This software is licensed under a MIT license, but request users cite our publication.
Jonathan D. Smith, Samuel Hall, George Coombs, James Byrne, Michael A. S. Thorne, J. Alexander Brearley, Derek Long, Michael Meredith, Maria Fox, (2022), Autonomous Passage Planning for a Polar Vessel, arXiv, https://arxiv.org/abs/2209.02389
For more information please see the attached ``LICENSE`` file.
Raw data
{
"_id": null,
"home_page": null,
"name": "meshiphi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Polar Science, Geospatial, Marine Science",
"author": null,
"author_email": "\"Autonomous Marine Operations Planning (AMOP) Team, AI Lab, British Antarctic Survey\" <amop@bas.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/b6/94/60bcf4ce278333e096dabe8e3c704d944c2b327614edaf0f2f727dbcc46a/meshiphi-2.1.15.tar.gz",
"platform": null,
"description": "# Meshi\u03c6 (MeshiPhi)\n\n\n\n<!-- <a href=\"https://colab.research.google.com/drive/12D-CN10X7xAcXn_df0zNLHtdiiXxZVkz?usp=sharing\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\" alt=\"Colab\"> -->\n<a href=\"https://antarctica.github.io/MeshiPhi/\"><img src=\"https://img.shields.io/badge/Manual%20-github.io%2FMeshiPhi%2F-red\" alt=\"Manual Page\"></a>\n<a href=\"https://pypi.org/project/meshiphi/\"><img src=\"https://img.shields.io/pypi/v/meshiphi\" alt=\"PyPi\"></a>\n<a href=\"https://github.com/antarctica/meshiphi/tags\"><img src=\"https://img.shields.io/github/v/tag/antarctica/MeshiPhi\" alt=\"Release Tag\"></a>\n<a href=\"https://github.com/antarctica/MeshiPhi/issues\"><img src=\"https://img.shields.io/github/issues/antarctica/MeshiPhi\" alt=\"Issues\"></a>\n<a href=\"https://github.com/antarctica/MeshiPhi/blob/main/LICENSE\"><img src=\"https://img.shields.io/github/license/antarctica/MeshiPhi\" alt=\"License\"></a> \n\n\n\nIntroducing Meshi\u03c6, a versatile software package designed for comprehensive earth modeling and navigation planning. Meshi\u03c6 works by discretizing the Earth's surface into a non-uniform grid, allocating higher resolution in regions of geographic diversity, and conserving lower resolution in more uniform regions. The software also incorporates data-driven vehicle models, with the ability to calculate speed limits and fuel needs for specific vessels within each grid cell. These mesh objects can be output in standard formats, such as GeoJSON and GeoTIFF, enabling data-visualisation via GIS software such as ArcGIS. \n\n## Installation\nMeshi\u03c6 can be installed via pip or by cloning the repository from GitHub.\n\n Pip: \n```\npip install meshiphi\n```\n\nGithub: (for local development)\n```\ngit clone https://github.com/Antarctica/MeshiPhi\ncd MeshiPhi\npip install -e .\n```\n\nThe Meshi\u03c6 package has an optional dependency on GDAL, which is required to produce outputs in GeoJSON or GeoTIFF formats. More information on setting up GDAL can be found in the manual pages linked above. Once these requirements are met then the software can be installed by:\n\n> NOTE: The installation process may vary slightly dependent on OS. Please consult the documentation for further installation guidance.\n\n## Documentation\nSphinx is used to generate documentation for this project. The dependencies can be installed through pip:\n```\npip install sphinx sphinx_markdown_builder sphinx_rtd_theme rinohtype\n```\nWhen updating the docs, run the following command within the MeshiPhi directory to recompile.\n```\nsphinx-build -b html ./docs/source ./docs/html\n```\nSometimes the cache needs to be cleared for internal links to update. If facing this problem, run this from the MeshiPhi directory.\n```\nrm -r docs/build/.doctrees/\n```\n\n## Required Data sources\nMeshi\u03c6 has been built to work with a variety of open-source atmospheric and oceanographic data sources. \nA list of supported data sources and their associated data-loaders is given in the \n'Data Loaders' section of the manual\n\n\n## Developers\nSamuel Hall, Harrison Abbot, Ayat Fekry, George Coombs, Jonathan Smith, Maria Fox, and James Byrne \n\n## Collaboration\nWe are currently assessing the best practice for collaboration on the codebase, until then please contact [polarroute@bas.ac.uk](polarroute@bas.ac.uk) for further info.\n\n\n## License\nThis software is licensed under a MIT license, but request users cite our publication. \n\nJonathan D. Smith, Samuel Hall, George Coombs, James Byrne, Michael A. S. Thorne, J. Alexander Brearley, Derek Long, Michael Meredith, Maria Fox, (2022), Autonomous Passage Planning for a Polar Vessel, arXiv, https://arxiv.org/abs/2209.02389\n\nFor more information please see the attached ``LICENSE`` file. \n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 British Antarctic Survey Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "MeshiPhi: Earth's digital twin mapped on a non-uniform mesh",
"version": "2.1.15",
"project_urls": {
"Documentation": "https://antarctica.github.io/MeshiPhi",
"Homepage": "https://www.bas.ac.uk/project/autonomous-marine-operations-planning",
"Issues": "https://github.com/antarctica/MeshiPhi/issues",
"Repository": "https://github.com/antarctica/MeshiPhi"
},
"split_keywords": [
"polar science",
" geospatial",
" marine science"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c879afeee1bf4a8c199c58c9315806b7a75ba4d6a7c0912ec5ed4dac2fed1f97",
"md5": "d4d878c45ba88702a71137c2581e9237",
"sha256": "0868e9dce79f44e4449e4b5dd1693f377ed6636d57a0d5ef15485c621a7063f4"
},
"downloads": -1,
"filename": "meshiphi-2.1.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4d878c45ba88702a71137c2581e9237",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 129953,
"upload_time": "2024-11-06T16:02:03",
"upload_time_iso_8601": "2024-11-06T16:02:03.811250Z",
"url": "https://files.pythonhosted.org/packages/c8/79/afeee1bf4a8c199c58c9315806b7a75ba4d6a7c0912ec5ed4dac2fed1f97/meshiphi-2.1.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b69460bcf4ce278333e096dabe8e3c704d944c2b327614edaf0f2f727dbcc46a",
"md5": "6a7f38f1ab0851d6f08bd82af5b1e67f",
"sha256": "83a4da3ec7361ae39e032ed45e08ce235025542e8a8d714c9c4a97b89622f522"
},
"downloads": -1,
"filename": "meshiphi-2.1.15.tar.gz",
"has_sig": false,
"md5_digest": "6a7f38f1ab0851d6f08bd82af5b1e67f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 103997,
"upload_time": "2024-11-06T16:02:06",
"upload_time_iso_8601": "2024-11-06T16:02:06.616201Z",
"url": "https://files.pythonhosted.org/packages/b6/94/60bcf4ce278333e096dabe8e3c704d944c2b327614edaf0f2f727dbcc46a/meshiphi-2.1.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-06 16:02:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "antarctica",
"github_project": "MeshiPhi",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "meshiphi"
}
