| | 155 | `fedd_image.py` creates visualizations of federated experiments at a box and lines level, showing the interconnections between elements. The visualizations can be generated from an active federated experiment, a [FeddPluginArchitecture#TopologyDescriptionLanguage topdl] description, or an ns2 description. `fedd-image.py` calls out to graphviz's `neato` program to draw the graphs, so it or a compatible program must be available. |
| | 156 | |
| | 157 | Internally, the various representations are converted to topdl and from there into the `neato` specification. An active experiment's topdl description must be pulled frmo teh experiment controller it was created on and a local ns2 description must be translated by a fedd into topdl. Topdl descriptions can be drawn without contacting a fedd. |
| | 158 | |
| | 159 | `fedd_image.py` takes the following arguments in addition to the standard ones: |
| | 160 | |
| | 161 | '''--experiment_cert='''''filename'':: |
| | 162 | The ''filename'' must contain a certificate valid for the experiment's fedid. If so it is used to authenticate access to the experiment. A password may be required if one has been added to the private key. |
| | 163 | '''--experiment_name='''''name'':: |
| | 164 | The local name of the experiment to query. Only the experiment creator can use this for access. |
| | 165 | '''--file='''''filename'':: |
| | 166 | File containing the [FeddAbout#ExperimentDescriptions experiment description]. |
| | 167 | '''--format='''''fmt'':: |
| | 168 | The image format to use. Valid choices are '''jpg''', '''png''', '''svg''', and '''dot'''. '''dot''' is graphviz input. |
| | 169 | '''--labels''':: |
| | 170 | Include node names and IP address information in the image. This is the default. |
| | 171 | '''--no-labels''':: |
| | 172 | Omit node names and IP address information in the image. |
| | 173 | '''--output='''''file'':: |
| | 174 | A file to store the image in. If '''--format''' is given, otherwise the last three characters of the filename are taken as a '''--format''' specification. |
| | 175 | '''--pixels='''''pix'':: |
| | 176 | Output an image that is ''pix'' pixels, square. |
| | 177 | '''--program='''''path'':: |
| | 178 | A `neato` compatible program to draw the graph. This may be helpful if graphviz is installed in a non-standard place or with a non-standard name. |
| | 179 | |
| | 180 | |
