xmstool_tribs

Description

Tools for generic workflows to support the development of tRIBS models.

Badges

Authors and acknowledgment

Aquaveo developers.

License: BSD - 2 Clause

Copyright (c) 2026 Aquaveo All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, 
  this list of conditions and the following disclaimer.
- 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.

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.

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_tribs.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, xmscoverage, 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.