Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "STEM Model Generator"
(→Configure Model Properties) |
(→Configure Model Parameters) |
||
Line 113: | Line 113: | ||
When you're finished, click '''Next''' to configure the '''Model Parameters''' | When you're finished, click '''Next''' to configure the '''Model Parameters''' | ||
− | ==== Configure Model Parameters ==== | + | ==== Configure Model Parameters ==== |
+ | |||
+ | Model parameters - also called rate parameters - represent user-configurable variables that can be passed into the computational model. The values can represent many things, but are often variables to the differential equations that make up the model. Users are asked to provide values for these parameters when a new Disease/Population/etc is created in STEM. Examples include '''Transmission Rate''', '''Immunity Loss Rate''', etc. | ||
+ | |||
+ | By default, a model inherits parameters from its ancestor models. These are show in <span style="color: #a0a0a0; font-style:italic;">light gray italics</span>. '''You cannot edit or remove parameters inherited from another model.''' | ||
+ | |||
==== Configure Model Compartments ==== | ==== Configure Model Compartments ==== | ||
Revision as of 13:53, 5 September 2012
Contents
About
Holder page for model generator
Installation
Important note: the STEM Model Generator is currently intended for use in the Eclipse SDK only. It is not intended for installation or use within the STEM application.
- Follow the steps of the STEM/Eclipse Setup to prepare your development environment
- Add the STEM Model Generator Update Site into Eclipse
- Launch your Eclipse SDK
- Select the Help menu and choose Install New Software
- Image
- When the Available Software dialog opens, click Add
- In Add Repository dialog, enter the following values:
- Name: STEM Developer Tools
- Location: http://download.eclipse.org/stem/update-site/prerelease/
- Image
- Click OK
- Install the STEM Model Generator
- From the Available Software dialog, select STEM Developer Tools from the drop down
- Choose the STEM Model Generator Feature from the list of available software
- Note: You may have to uncheck Group items by category
- Image
- Click Next
- On the Install Details page, verify STEM Model Generator Feature is listed
- Note: If you did not install the Eclipse Modeling Framework (EMF) previously, it will be installed automatically
- Image
- Click Next
- On the Review Licenses page, review the licenses of the required software
- If you accept all the license terms, select I accept the terms of the license agreements and click Finish
- If you do NOT accept the terms, click Cancel
- The installer will now download and install the software. This process may take 5-10 minutes.
- If prompted with a Security Warning that you're about to install unsigned content, click OK
- Image
- When the install finishes, you will be prompted to restart Eclipse
- If all your changes are saved, click Restart Now
- Otherwise, click Not Now, save any changes, and restart Eclipse
- Image
- After Eclipse restarts, the STEM Model Generator is ready for use
Create a new STEM Computational Model Project
Launch the STEM Model Generator Wizard
- Open the Eclipse SDK
- Open the File menu, New, and choose Other
- You can also do Control-N (Command-N on Mac OS X)
- In the list of Wizards, expand the STEM category and select New STEM Model Project
- Click Next
- Choose Create and configure a new STEM Model Package
- Image
- Click Next
Configure the Model Package
The model package is the container for all models in a given package. A model package generates an Eclipse plug-in project.
Parameter Name Data Type Example Value Package Name String
(Java Identifier)CattleSalmonellosis Package Prefix String
(Java Package Identifier)com.example.diseasemodels
The Package Name and Package Prefix are combined to create the resulting Eclipse plug-in/project identifier. For example, the model package with values above will generate an Eclipse plug-in/project with ID com.example.diseasemodels.cattlesalmonellosis.
Add/Edit a Computational Model
When you're ready to add a computational model to the package, from the Model Package page, click Add Model.
- If you want to edit an existing computational model, choose it from the Contained Models list and click Edit Model.
This will launch the Computational Model Wizard.
Configure Model Properties
Model properties are the most basic settings of a STEM Computational Model. Properties include the model's name, the model's type, and which parent model it extends and inherits parameters and compartments from. All are required.
- Image
Property Type Example Description Model Name String
(Java Identifier)CattleSalmonella The model's name. This value will be the Java class name of the generated model. Should contain alphanumeric characters, no spaces, and cannot begin with a number. Model Type String from list DiseaseModel The underlying model type. If you're implementing a Disease Model, select DiseaseModel. A Population Model, select PopulationModel. This value is used to find appropriate parent models. Parent model Computational Model SIR The computational model this new model will extend. If you're not sure, select the textbook model that most closely resembles the compartment model you're implementing (SI, SIR, SEIR)
When you're finished, click Next to configure the Model Parameters
Configure Model Parameters
Model parameters - also called rate parameters - represent user-configurable variables that can be passed into the computational model. The values can represent many things, but are often variables to the differential equations that make up the model. Users are asked to provide values for these parameters when a new Disease/Population/etc is created in STEM. Examples include Transmission Rate, Immunity Loss Rate, etc.
By default, a model inherits parameters from its ancestor models. These are show in light gray italics. You cannot edit or remove parameters inherited from another model.