Plugin Examples

/wiki/spaces/SC/pages/51643422For plugin examples please get access to the source code: Accessing the source code and getting started

Once you have the source code open the solution eApp\SourceCommunity\ExamplePlugins\ExamplePlugins.sln

We have built a number of plugin examples:

Project	Demonstrates	Current state	Requires persistence
ExampleExpressionEditorCustomFunctions	Shows the syntax for adding in your own custom function	Full tutorial available with the user guide
ExampleRainfallRunoffModel	Provides an example rainfall runoff model.	Full tutorial available with the user guide
ExampleScenarioTool		Needs to be cleaned up. Full tutorial available with the user guide
Plugins below don't have tutorials and are "By Example":
ExampleConstituentFilteringModel	How to create a custom constituent filter model
ExampleObjectiveFunction	Demonstrates how to put a custom Objective function in the calibration tool. (Available in 3.4.1 onwards)	Good example
ExampleConstituentGenerationModel	How to create a custom generation model
ExampleGeographicScenarioStep	Adding in a geographic step to the wizard	Simple example
ExampleIPluginStep	Shows how you can plug-in to the model running
ExampleNodeModel	Shows the various components needed to create a custom Node Model
ExampleScenarioCreator	Shows how to create a new scenario from a csv file. Demonstrates RiverSystem.Simulation.ChangeFeatures which changes node models (Available in 3.4.1 onwards)  Also demonstrates how to set up Data Sources and Input Sets
ExampleWaterUserDemandModel
WorkshopExampleDataExportTransform	Accessing results from model runs, filtering results, performing data transformations and custom exporting.

If these examples don't help you and you would like to implement a particular plugin - please contact Geoff Davis to discuss the best way to implement what you would like to do.