xmstool

Branches

• release-7 - Current dev branch: uses xmstool_core release-5 which removed Param, can send constrained 2D UGrid or 2D mesh.
• release-6.0.0 - GMS 10.8, SMS 13.3, WMS 11.2

Description

Tools for use with XMS.

Badges

Authors and acknowledgment

Aquaveo developers.

License

Copyright (c) 2023 Aquaveo

This software is for use by Aquaveo and its authorized personnel ONLY.

Development Guidelines

• Keep in mind that these are guidelines.
• Tool names
  • Keep it short - 3 words or fewer is best if possible.
  • Capitalize using title case.
  • Use “This from That” pattern if appropriate (and not “This to That”). “This from That” puts the object of the tool, which is probably the most important thing, as the first word.
  • Avoid words like “Convert” and “Create” (e.g. “Create Bridge Footprint” should just be “Bridge Footprint”).
  • Don’t use symbols (like “->”).
  • Dialog title must exactly match name of tool.
  • A tool only has one name (don’t say “also called the blankety blank tool”).
  • Class name should match tool name.
• Argument names
  • Use sentence case, not title case.
• Tool.xml
  • Add tool to Tools.xml, in alphabetical order.
  • Put the tool in the folder that matches what the tool creates (if it creates a UGrid, put it in the Unstructured Grids folder).
  • Model specific tools can just be in the model folder.
• Code
  • Consider putting the majority of code in xmstool.xms.tool.algorithms and having the tool class be fairly thin. This way the code will be easier to reuse in other tool code.
  • Furthermore, consider if some or most of the algorithmic code should go in one of our other basic libraries (xmsconstraint, xmsgrid, etc.). The reason for this is that xmstool will end up depending on all of our basic libraries, so we can’t have those libraries depend on xmstool or there will be circular dependencies. If the code is useful in another basic library, then it shouldn’t be in xmstool.
  • Don’t use raw GDAL. Call xmsgdal instead.
  • Don't use private tool member variables or methods. For instance don't use self._data_hander. Instead create a public API to do the same thing.
• Wiki help
  • Follow this outline (all headings use Title Case).
    • “Tool name” without the word “tool” - heading 3
    • “Input Parameters” - heading 4
      • Bulleted list
    • “Output Parameters” - heading 4
      • Bulleted list
    • “Current Location in Toolbox” - heading 4
    • “Examples” - heading 4
      • “Example 1” - heading 5
    • “Related Tools” - header 4
  • Add tool to xmswiki Tool Dialog Help.