The functionality of RivEX, developed in python, has been packaged up as geo-processing script tools. The toolbox can be directly navigated to in the Catalog pane and is found in it's install location C:\RivEX_ArcPro. Even more convenient is to connect the RivEX toolbox to your project; this allows you to customise your ArcPro Project and expose RivEX tools in locations that best suit your needs.


Using tools directly from the RivEX toolbox


With the RivEX toolbox added to your project you can use the tools directly from the toolbox just like any other system tool.  This is the intended way you would interact with the RivEX tools. RivEX maintains a special folder called the RivEX Workspace where it stores outputs, error logs and a settings file. The workspace and its settings file work together to simplify the user experience so many of the RivEX tools are just a few parameters for you to consider.  All tools are supported by this extensive help file.


Using RivEX tools in model builder


RivEX tools, like any other system tool, can be used in model builder. Here you can build and automate your own custom workflows. Below is an example of a model using three RivEX tools to snap sites to the network, transfer the catchment ID's, apply a definition query filtering for sites to catchment ID 123 and this subset is passed into the extract positional information tool.



An example model to demonstrate how you could integrate RivEX tools into a custom workflow.


Unlike system tools, RivEX does not typically honour environment settings. RivEX retains control over the outputs and most tools need to access the topo-cache folder which RivEX created.  For example, setting processing extents, a commonly used environment setting, would conflict with the needs of accessing the structured cache files.


Using RivEX in python scripts


For advance users only, the tools in the RivEX toolbox can be called with a python scripting environment.


Be aware some tools were designed to be run directly from the toolbox in an active ArcPro session and were never intended to be run in model builder or python. These few tools list this expectation in the limitations section of the tool's help page. These are principally the admin and prepare tools.


The rest of the tools can be used within a script.  Each tool has a code sample showing the minimum code required to use the tool and access output. Note the parameter index starts at zero like all other standard geo-processing tools.  Therefore the first parameter in any tool is in the index position zero and not one.


Warning Some tools will fail if you use them in a script and provide as input a layer with a selection, instead of a path to a feature class. RivEX does many internal quality control checks and some code expects the layer to be coming from a map.  These tools will state this limitation in the Warning section on the help page. If you need to pass in selections you need to run the tool directly from toolbox in an active ArcPro session or run your script from the python console within ArcPro.

Return to top of page