Note: This is documentation for version 5.4 of Source. For a different version of Source, select the relevant space by using the Spaces menu in the toolbar above

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:

ProjectDemonstratesCurrent stateRequires persistence
ExampleExpressionEditorCustomFunctionsShows the syntax for adding in your own custom function Full tutorial available with the user guide(error)
ExampleRainfallRunoffModelProvides an example rainfall runoff model.Full tutorial available with the user guide(tick)
ExampleScenarioTool
Needs to be cleaned up.
Full tutorial available with the user guide
(error)
Plugins below don't have tutorials and are "By Example":
ExampleConstituentFilteringModelHow to create a custom constituent filter model
(tick)
ExampleObjectiveFunctionDemonstrates how to put a custom Objective function in the calibration tool. (Available in 3.4.1 onwards)Good example(error)
ExampleConstituentGenerationModelHow to create a custom generation model
(tick)
ExampleGeographicScenarioStepAdding in a geographic step to the wizardSimple example(error)
ExampleIPluginStepShows how you can plug-in to the model running
(tick)
ExampleNodeModelShows the various components needed to create a custom Node Model
(tick)
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


(error)
ExampleWaterUserDemandModel

(tick)
WorkshopExampleDataExportTransformAccessing results from model runs, filtering results, performing data transformations and custom exporting.
(error)


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.