Primer on use of the SWIM IPS now available
Controlling the Portal
Document Actions
Config File Entries
Five entries in the global configuration section of the configuration file are possibly communicated to the portal. The first three entries (COMMENT, TAG, and USER) are optional. Here's a brief description of the different entries, along with sample values:
- COMMENT = Testing the monitor and portal interface
This entry contains a comment (text field) that describes the simulation run based on this configuration file. No comment is sent if this entry is omitted.
- TAG = Grouping Tag
This entry can be used to group several simulation runs together, by assigninig the same tag to each one of them, to facilitate simulation archives queries. No tag is used if thi sentry is not specified.
- USER = elwasif
The user name for this simulation. The framework uses the UNIX user name of the user launching the simulation if this entry is missing.
- PORTAL_URL = http://swim.gat.com:8000/monitor
This is a REQUIRED entry for portal communication. It contains the URL of the SWIM portal monitoring web site. The URL listed here is the cuurent location of the SWIM portal.
- RUNID_URL = http://swim.gat.com:4040/runid.esp
This entry is REQUIRED for portal communication. It contains the URL for the portal service that generates a unique portal run ID that is associated with this run. The framework services can be queried for the portal run ID value (it is stored as configuration parameter PORTAL_RUNID).
Along with portal monitoring, the framework also outputs an event log file that is stored in the directory specified in the configuration entry SIM_ROOT. The name of this file is uniquely generated using Python' built-in uuid modules. The name of this file has the form SIM_NAME-PORTAL_RUNID.eventlog if the portal URLs are specified and are accessible. Otherwise it has the form SIM_NAME-UUID.eventlog (e.g. TEST_monitor_elwasif-f31961d1-6579-4c9b-8874-af96c7705634.eventlog).
Turning it Off
If, for some reason, you don't want any record of your run to appear on the portal, please first take a moment to tell the SWIM CS team why you don't want it there. Is there a privacy or a scientific priority issue? Do you think it has been causing problems of some kind? The best way to let us know is to file a ticket in the Trac system
If you really want to turn off the portal connection for your run, here's how. You simple need to delete (or comment out) the entries for PORTAL_URL and RUNID_URL in the configuration file. The local event log is still generated using a UUID entry for the portal run ID.