Documentation

Getting Started

General Info

Beam

Structural 3D

Section Builder

Member Design

RC Design
General
Code Verification


Connection Design

API

Can't find what you're after?

Analysis Report

An analysis report can be generated by the API. This is an optional property to the input. The response object (output) will have a corresponding "analysis_report" key which will contain the links to download the generated text or pdf report.

Input Type Description
analysis_report Object Define the properties to your analysis report, including whether it is text or pdf, load combinations, and the sections which appear in the report.

"analysis_report" Properties

Properties Type Default Value Description
job_name String "Default Job Name" The job name is the name that appears in the report.
file_type String "txt" The file format of the report. Choose between "txt" and "pdf". "txt" will be smaller in size and thus quicker to run than "pdf".
load_combinations Array [0] Optional property. If this property is defined, it expects an array with comma separated numbers as the value. The numbers must correspond with the indexes of the load combinations defined in the "load_combinations" property.

If this property is missing, then the analysis will be based on the first valid load combination. If your input does not have load combinations, the analysis will be based on the the loads as they are applied.
sections Object {...} Define the sections to display in the report in this property. Each of the properties within the "sections" properties are booleans.

"sections" Properties

Properties Type Default Value Description
title_page Boolean false The title page section. Only available for "pdf" reports.
job_setup Boolean false The job setup section. Provides details on the unit system, and quantity of nodes, members, plates, sections etc.
bom Boolean false The bill of materials section. Provides details on the quantities of members with details of lengths, mass, and section along with the quantities of plates with details of thickness, material, and mass.
nodal_reactions Boolean false The nodal reactions section.
nodal_forces Boolean false The nodal forces section.
nodal_displacements Boolean false The nodal displacements section.
member_forces Boolean false The member forces section.
member_displacements Boolean false The member displacements section.
member_stresses Boolean false The member stresses section.
buckling Boolean false The buckling section.
plate_nodal_forces Boolean false The plate nodal forces section.
plate_element_forces Boolean false The plate element forces section.
plate_nodal_moments Boolean false The plate nodal moments section.
plate_element_moments Boolean false The plate element moments section.
plate_displacements Boolean false The plate displacements section.
plate_nodal_stresses Boolean false The plate nodal stresses section.
plate_element_stresses Boolean false The plate element stresses section.
plate_nodal_equiv_stresses Boolean false The plate nodal equivalent stresses section.
plate_element_equiv_stresses Boolean false The plate element equivalent stresses section.

Example

{
  "analysis_report": {
    "job_name": "Example Job Name",
    "file_type": "txt",
    "load_combinations": [
      0,
      1
    ],
    "sections": {
      "title_page": true,
      "job_setup": true,
      "bom": true,
      "nodal_reactions": true,
      "nodal_forces": true,
      "nodal_displacements": true,
      "member_forces": false,
      "member_displacements": false,
      "member_stresses": false,
      "buckling": false,
      "plate_nodal_forces": false,
      "plate_element_forces": false,
      "plate_nodal_moments": false,
      "plate_element_moments": false,
      "plate_displacements": false,
      "plate_nodal_stresses": false,
      "plate_element_stresses": false,
      "plate_nodal_equiv_stresses": false,
      "plate_element_equiv_stresses": false
    }
  }
}