https://docs.optrix.com.au/ Wed, 27 May 2026 01:25:14 +0000 FeedCreator 1.8 https://docs.optrix.com.au/_media/wiki:dokuwiki.svg https://docs.optrix.com.au/ https://docs.optrix.com.au/model:addcalc AddCalc The AddCalc function is part of the model object. It's used to add new calculations to your model. These are very similar to outputs, however the results aren't published. Syntax model.AddCalc(Name,Lambda Expression,Dependencies) Parameters Name: A string containing the human-readable name of this point. As this point is not published, it's only use is when performing internal binding (ie. when you're referencing this calculation from a different model). anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:addconstant AddConstant The AddConstant function is part of the model object. It's used to add new constants to your model. Syntax model.AddConstant(Name,Default) Parameters Name: A string containing the human-readable name of this point. This name will appear everywhere the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:addinput AddInput The AddInput function is part of the model object. It's used to add new inputs to your model. Syntax model.AddInput(Name,Default,Source) Parameters Name: A string containing the human-readable name of this point. This name will appear everywhere the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:addoutput AddOutput The AddOutput function is part of the model object. It's used to add new outputs to your model. Syntax model.AddOutput(Name,Lambda Expression,Dependencies) Parameters Name: A string containing the human-readable name of this point. This name will appear everywhere the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:calc Calculations Calculations are a type of data point that are used to calculate values that you don't want or need exposed to the users of your system. This might be for several reasons, such as.... * The value simply isn't of any use or interest to your users, anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:connect_our_model_to_data Connecting a Model to Data The AddInput command has an optional third parameter that controls where it gets its data from. If left None, it will simply wait for the data to be directly updated by the user, usually through OPC-UA. If given a string, it can link a couple of different data sources. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:constant Constants Constants are a type of data point that represents the values that are needed in the equations of your model. Unlike inputs - which are expected to change often - constants are expected to remain quite static and not change frequently. If you're ever considering adding a number to one of your equations that represents something real-world (such as the maximum speed limit of your machines, the weight of your product etc.), it's better to define it as a anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:creating_a_model_in_python Creating a Model in Python Building the Basics First, create a new blank Python file. You can name it anything you like, but it should end with the .py extension if you're running on a Windows machine. import ardimodel as mdl host = mdl.ModelHost(5225) #This is the port number that OPC-UA will run on # Add Models Here host.ardiurl = "localhost" host.ardisite="default" host.Run() anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:data_points Data Points Your model is made up of data points. These data points can be inputs, constants, outputs or calculations. Each point usually contains a single numeric or text value. However, calculations can break this rule and store Python objects. Every data point other than calculations are available through anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:fixing_and_upgrading_the_model Adding Logic to Equations In our example, we created a very simple model telling us how many seconds of water we have stored in our tank. Handling Divide-By-Zero If you're doing anything with rates and speeds, you'll likely come up across a divide-by-zero error at some point. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:goalseek_function GoalSeek The GoalSeek function is part of the model object. It's used to find the ideal value of one measurement to result in a particular value of another. For example, you might have made a model that calculates the size of a balloon from a specific pressure of air. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:goalseek Goal Seeking Goal-seeking is a function available in many analytics packages (for example, it's part of What-If Analysis in Excel). It asks the question “What do I need to change 'A' to so that 'B' is equal to 'C'”? In our example, we used it to determine what the level of our tank needs to be to ensure that we have at least 60 seconds of water available. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:input-only_models Input Only Models In some cases, there might be a large number of models that use the same inputs. When this happens, you might want to consider an Input-Only Model. This is a model that only exists to be a source of information to other models. If you were working on a production line for example, the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:input Inputs Inputs are a type of data point that represents the values that are fed into your model. The values are expected to vary frequently, both based on real-world data and because they'll be part of your 'what if?' questions you want to ask the model later. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:model Models Models are sets of data points that translate one or more inputs and constants into outputs and calculations. Complex systems - those with several distinct pieces - will often be broken up into several smaller models. This is because it's much easier to develop, test, debug and sign-off on individual pieces of the system than it is to try and build the entire thing at once. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:monitoring_the_model Monitoring a ModelHost Model If you want to monitor the status of a ModelHost model, there are a few OPC-UA points you can use. Service Running First, if the model isn't running at all, you won't be able to connect to the OPC-UA server. Process Responding anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:multiple_return_values_from_a_function Multiple Return Values from a Function The Problem In some cases, you might have a Python function that returns multiple values. This is very common when you're trying to balance several different inputs or outputs. The difficulty is that each output can only return a single value - so how do you make sure that you get anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:opc-ua OPC-UA OPC Unified Architecture (simplified to OPC-UA) is an industrial communication protocol which allows different brands of equipment to connect to one-another using a consistent protocol. Many industrial systems already communicate through OPC-UA, and for those that don't there are a range of protocol converters that allow it. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:output Outputs Outputs are a type of data point that contain the values that are produced by your model. Calculations are very similar to outputs, but they aren't published (made available to users). Outputs are available but not writable from OPC-UA. Example anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:published Publishing Published data points are the points that are available to the user, usually through the Modular Output System. Every kind of data point other than calculations are published. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:reverse-engineering_with_goalseek Flipping Your Model with Goalseek Although it is possible to figure out how to solve equations for different variables, it can become incredibly complex to do when there's a lot of variables or calculations involved. Based on our example - where we determine how many seconds of water we have left in the tank - we want to determine anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:running_a_model Running a Model Models are Python scripts - you can run them from a Windows command-line or Linux terminal. For instance, in Linux you'd run a command similar to the one below... python3 mymodel.py And in Windows you'd have something like below, with anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:running_multiple_model_processes Running Multiple Model Processes If you are going to run several different Python models in different processes (for example, you might have different modelling teams working on different areas of your plant), you will need to take some extra steps during setup. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:sidebar ModelHost Introduction Basic Structure Intro Your First Model Adding Logic Connecting to Data Goal-Seeking Functions AddCalc AddConstant AddInput AddOutput GoalSeek More Tips and Tricks Running a Model anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:start ARDI ModelHost ModelHost is a small Python library that allows you to create and host models of your system(s) that can be run, modified and tested on-the-fly. In this context, a model is a system that takes one or more input values, and produces one or more output values - they often calculate the physical limits on machines or perform analytics and classification on your data. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:structure_of_a_mathmodel The Structure of Hosted Models ARDI ModelHost actually allows you to run several models concurrently. To make it easy to work with and write, we normally suggest spreading complex systems into several distinct models. Having your compressed-air system distinct from your electrical system, or your boilers distinct from your chillers, will help you compartmentalise your work. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:tips_and_tricks Tips and Tricks Below you'll find some tricks, techniques and guides to working with ModelHost models. Multiple Return Values from a Function Input Only Models Running a Model Running Multiple Model Processes Monitoring a ModelHost Model Working With Time anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/model:working_with_time Working With Time While most ModelHost models only need to respond to changes in data, some models are time-sensitive (such as forecasting models, running averages/standard deviations or time-series AIs). You can force an output to update once every second by making the output depend on the internal ModelHost clock. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000