S-Frame Open API

Michael Halliday
Michael Halliday Altair Community Member
edited November 2023 in Community Q&A

Where can I find documentation for the S-Frame Open API?  I would like to see what can be done with it, specifically in S-Foundation.

Tagged:

Answers

  • Matthew_Sauer1
    Matthew_Sauer1
    Altair Employee
    edited November 2023

    Hello Michael,

    I hope all is well.

    I'm afraid that a comprehensive documentation is not yet available, but with that said, our Command History is a great way to expose the API syntax from GUI commands.  This is a helpful way to learn the API, and we actually have a video on this very topic you can access here:


    https://www.youtube.com/watch?v=G6o--us2UD4

    Regards,
    Matthew Sauer

    Altair Support

  • Michael Halliday
    Michael Halliday Altair Community Member
    edited November 2023
    Thanks Matt I will check that out. Does this also work for your other software?
  • Matthew_Sauer1
    Matthew_Sauer1
    Altair Employee
    edited November 2023
    Michael Halliday said:

    Thanks Matt I will check that out. Does this also work for your other software?

    Hi Michael,

    This concept will work for S-FOUNDATION, S-TIMBER, and S-CALC. However, at this time, the other solutions do not have API access.  May I ask, did you have any specific actions in mind you were hoping to accomplish via the API?

  • Michael Halliday
    Michael Halliday Altair Community Member
    edited November 2023

    Thanks, Matt,

    Right now we are looking to try to automate the design of pre-engineered steel buildings.  When we design these foundations the building manufacturer will send us tables of unfactored reactions for each frame.  Currently, we combine them in Excel but I am hoping we can utilize S-Foundation and the API to assist.

  • Matthew_Sauer1
    Matthew_Sauer1
    Altair Employee
    edited November 2023
    Michael Halliday said:

    Thanks, Matt,

    Right now we are looking to try to automate the design of pre-engineered steel buildings.  When we design these foundations the building manufacturer will send us tables of unfactored reactions for each frame.  Currently, we combine them in Excel but I am hoping we can utilize S-Foundation and the API to assist.

    Hi Michael,

    I'm not sure if this method will 100% satisfy your requirements, but I thought it may be useful.  This article showcases a workflow where CSV file data representative of foundation nodal coordinates, reaction loads, load cases, and load combinations are imported into S-FOUNDATION for the purposes of designing a foundation with forces that come from a 3rd party application.  This allows you to factor the loads as you wish, and manipulate the data in excel prior to importing into S-FOUNDATION for design checks.  Perhaps this could be of use?  These wizards are also Python scripts behind the scenes, and can be modified, if required.  We'd love to hear if this would work for you.

     

Categories