Creating an HTML report

HTML report

You can produce HTML documentation for your system very easily and rapidly. The HTML report will contain the circuit schematics, a description of the components and line submodels, the contents of supercomponents, graphs and eigenvalues and other useful information. Simcenter Amesim provides a standard report but you can create custom templates if you know HTML and if you want to complete your reports.

Create an HTML report

Create an HTML report

HTML report create an HTML report

To create an HTML report, do the following:

1. In the File menu, select Model documentation > Create....

The following dialog box appears: Figure 41: HTML Report dialog box

As you can see, the name of the report (in the first field Save HTML report as) is a default value; it is stored in the same directory as the model and has the same name as the model followed by an underscore, and a .html extension. When you click OK, the HTML report is generated, and when the model is saved this report and its associated folder (containing its images) are saved in the .ame file. The advantage of this is that if you move the model to a different directory or machine, its report is not lost; as soon as the model is opened in Simcenter Amesim you can access it through the Model documentation > Display menu item, or by right-clicking on the sketch and selecting Help from the contextual menu. Warning You can edit the Save HTML report as field in order to assign a different name to the HTML report. However, we recommend that you keep the default name so that a link exists between the model and its documentation. In these conditions the HTML report is displayed in Simcenter Amesim when you right-click on the background of a sketch (not on a component or line), and select the Help item in the resulting popup menu. If this rule is broken, the Help item will not display your HTML report, you will have to open it manually in Help. If you move the model, the report will not follow it. You can, however, attach multiple HTML reports to a model through the Properties facility using the File property type and using the Link type:

See Properties for more information.

2. Select the options according to your needs:

Save HTML report as: Indicate the name of the HTML report and use the browser to define the save location.

Select the type of report: If you want to use your own template, select the HTML report with template checkbox. Use the browser to select which template you want to use.

Content definition: Select from Default (all data) or User defined. Selecting the User defined option allows you to define which items to include in the HTML report. When this option is selected, the Configure button is enabled. When you click the Configure button, the following dialog box appears:

The drop-down list allows you to select the pre-defined HTML report settings:

Here you can select from:

Default: include all items (all checkboxes are ticked automatically).

Custom: define which items to include.

None: select none of the items (clear the list).

When Custom is selected, you can use the checkboxes to include specific items in the HTML report. You can either select individual checkboxes to include individual items, or the "root" checkboxes to select all items in a group: Here a click on Model information will select all sub-items (Name, History, Properties)

Here, we select an individual item, History, in the Model information group

General

Software information

The version of the software used to create the circuit.

Creation date

Date the report was created.

Table of Contents

A table of contents for the report.

Model information

Name

The name of the circuit.

History

Entries in the Model history pane.

Properties

Properties configured in the Properties pane.

Sketch and parameters

Circuit

The circuit schematics.

Opened supercomponents

The details of any supercomponents present and open in the circuit. If a supercomponent is not currently open through a right-click > Open supercomponent, it is only listed as a component of the sketch, and its contents are not included in the HTML report.

Global parameters

The details of any global parameters in the circuit.

Components and lines

List the components and lines in the circuit.

Parameters: display the parameters of components and lines

Non default: display only parameters of components and lines

LA Status

List the Free states, Control variables and Observer variables in the circuit.

Runs and results

Run parameters

Include the Run parameters set for the circuit.

Batch parameters

Include any Batch parameters set for the circuit.

Watch parameters

Include any Watch parameters present in the circuit.

Watch variables

Include any Watch variables present in the circuit.

Experiments

Include any Experiments present in the circuit.

Open plots

Include any plots currently open in the circuit.

Eigenvalues

Include the eigenvalues for the circuit.

3. Click on OK. The HTML report is saved in the folder you indicated in the Save HTML report as area, and you are prompted to open the report:

Create a custom template

Create a template

HTML report create a template

If you know HTML and if you want to customize your HTML reports, you can create your own templates.

To create a template:

Using Windows Copy the %AME%/misc/custom_report_template.html file to your working directory (assuming that %AME% is the Simcenter Amesim installation directory).

Using Linux Copy the $AME/misc/custom_report_template.html file to your working directory (assuming that $AME is the Simcenter Amesim installation directory).

Modify the HTML template copy as you require.

Warning

You must not modify or delete the following paragraph entries which are used by Simcenter Amesim to generate HTML reports:

Copy

<p><!-- AME sketch --></p>
<p><!-- AME components --></p>
<p><!-- AME lines --></p>
<p><!-- AME graphs --></p>
<p><!-- AME supercomponents --></p>
<p><!-- AME eigenvalues --></p>
<p><!-- AME globalparams --></p>

Any kind of standard HTML code can be included in all other parts of the HTML file (fonts, images, colors...)