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. These mesh objects can be output in standard formats, such as GeoJSON and GeoTIFF, enabling data-visualisation via GIS software such as ArcGIS. The default end products are designed to work with PolarRoute.
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/bas-amop/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.
Meshiφ provides CLI commands. For example, to create a mesh:
create_mesh --config path/to/config.json --output path/to/output.geojson
Example configs are provided in examples/environment_config/.
To export a mesh:
export_mesh --input path/to/meshfile --format geojson --output path/to/output.geojson
For a full list of commands and options, run:
create_mesh --help
See the documentation for more details and advanced usage.
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
Samuel Hall, Harrison Abbot, Ayat Fekry, George Coombs, David Wyld, Thomas Zwagerman, Jonathan Smith, Maria Fox, and James Byrne
For more details on contributing, see the contributing guide.
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 LICENSE file.
If you use Meshiφ in your research, please cite our software and publication:
- See the
CITATION.cfffile for citation metadata.
You can also use the "Cite this repository" button on GitHub for formatted citations.