Welcome to the MeshiPhi Manual Pages

MeshiPhi is a tool for the discretisation of environmental data with a non uniform resolution based on the variance of the data. This software package has been developed by the British Antarctic Survey (BAS). It was initially designed as part of a route planning tool for the BAS research vessel RRS Sir David Attenborough, although it can be applied to any geospatial data. The software is written in Python and is open source.

The package contains limited plotting functionality, which is described in the Mesh Plotting section. For extended plotting functionality, we recommend using the GeoPlot package, which was also developed at BAS. This is available from the following GitHub repository: GeoPlot

For more information on the project, please visit the AMOP website and follow our GitHub repository.

Note

The development of this codebase is ongoing and not yet complete. Please contact the developers for more information.

Contents:

• 1. Installation
  • 1.1. Installing MeshiPhi
  • 1.2. Installing GDAL (Optional)
• 2. Examples
  • 2.1. Creating the Digital Environment.
• 3. Command Line Interface
  • 3.1. create_mesh
  • 3.2. export_mesh
  • 3.3. rebuild_mesh
  • 3.4. merge_mesh
  • 3.5. plot_mesh (GeoPlot)
  • 3.6. meshiphi_test (for developers)
• 4. Background
  • 4.1. Code Structure
• 5. Configuration Overview
  • 5.1. Configuration - Mesh Construction
  • 5.2. Config Validation
• 6. Outputs - Data Types
  • 6.1. The Mesh.json file
• 7. Dataloader Overview
  • 7.1. Dataloader Interface
  • 7.2. Dataloader Factory
  • 7.3. Scalar Dataloaders
  • 7.4. Vector Dataloaders
  • 7.5. LUT Dataloaders
  • 7.6. Adding New Dataloaders
  • 7.7. Section Overview
• 8. Methods - Mesh Construction
  • 8.1. Mesh Construction - Overview
  • 8.2. Mesh Construction Design
  • 8.3. Mesh Construction Use case
  • 8.4. Mesh Construction - Additional
• 9. Mesh Plotting
  • MeshPlotter