Repast Py Component Reference


These documents are a reference to the components that ship with Repast Py. If you are unfamiliar with Repast Py and how it uses components, please see the introduction to Repast Py.

Some of the Repast Py components are based on Java classes. Many of the methods (roughly equivalent to 'actions' as described in the Repast Py document) in these base classes are available to their corresponding Repast Py components. For example, the Default Network Node is based on the Java class DefaultNode. Among the methods DefaultNode defines is getNumOutEdges() which returns the number of outgoing edges contained by that node. Because Default Network Node is based on DefaultNode, the method getNumOutEdges() is an action (a method) of the Default Network Node component and can be used when you write actions for that component.

The reference for individual components will list the associated Java class (if any) for Repast Py components as well as any methods (actions) or fields available to the Repast Py component. In addition, you can get more information about these associated classes in the javadoc documentation for RePast. The information is in html format in repastpy/docs/repast/api/index.html. When you bring this document up in your browser, you will see a list of Java classes in a frame in the lower left hand side of the browser. Search this list for the Java class you are interested in and click on it. The main frame in the browser should then give a description of the class, its methods (actions), and so forth.

Components