Structural Details Manager
  2. Structural Details Manager Tool
  3. Structural Details Manager

Structural Details Manager Tool

The Structural Details Manager (SDM) tool allows structural engineers to reprocess the structural drawing outputs generated by Friday to add/remove details and reorder the details in the catalog.

Initial setup

  1. Clone the repository git@gitlab.com:tangobuilder/jarvis/structural-details-manager.git following the instructions on the page How to clone a repository in the employee handbook.
  2. Install requirements by executing the following command: $pip3 install -r requirements.txt.

Add and remove details (Basic)

  1. Add the structural drawing dxf file (wood_lfwsw_shearWall_PlanViews.dxf) you want to process in the repository folder.

  2. Before executing the tool, add and/or remove details Ids from the wood_lfwsw_shearWall_PlanViews.dxf file.
    Note: If you want to add new details Ids in the model space to be processed by SDM, you need to add them in the layer A-ANNO-ID-INPUT.

  3. Run the ./bin/replaceDetailsID.py command to execute the tool as follows:

      ./bin/replaceDetailsID.py structural_drawings.dxf --keepID

    Where the arguments are:

    • wood_lfwsw_shearWall_PlanViews.dxf (required): Path to the dxf file containing the details ids.
    • --keepID (optional): If this argument is added, the outputs will keep the id after setting the page and slot. Otherwise will not.

  4. The tool will generate the following outputs:

    • wood_lfwsw_shearWall_PlanViewsbackup.dxf: This file contains the structural drawing plan views with the ids replaced with page and slot in the model space.
    • wood_lfwsw_shearWall_PlanViews_with_details.dxf: This file contains the structural drawing plan views with the ids replaced with page and slot in the model space and also the pages (paper spaces) with the details.
    • details.json: This file serves as an index for the details. It contains a list of pages per type of detail set: foundation, floor, wall, and roof, and each page contains a list of details in a specific order.

  5. Review the outputs generated by the tool. If the result is not what is expected, you can repeat the process from step 2.

Reorder details catalog (Advanced)

  1. Add the structural drawing files you want to process in the repository folder. This includes the wood_lfwsw_shearWall_PlanViews.dxf file and the details.json.

    The details.json file serves as an index for the details. It contains a list of pages per type of detail set: foundation, floor, wall, and roof, and each page contains a list of details in a specific order.

  2. Before executing the tool, revise the details.json file to reorder the details in the catalog.

  3. Run the ./bin/replaceDetailsID.py command to execute the tool as follows:

      ./bin/replaceDetailsID.py structural_drawings.dxf -i "details.json" --keepID

    Where the arguments are:

    • wood_lfwsw_shearWall_PlanViews.dxf (required): Path to the dxf file containing the details ids.
    • -i "details.json" (optional): detail index file. This argument -i should be followed by the path to the “details.json” file to take as input a reference details index.
    • --keepID (optional): If this argument is added, the outputs will keep the id after setting the page and slot. Otherwise will not.

  4. The tool will generate the following outputs

    • wood_lfwsw_shearWall_PlanViewsbackup.dxf: This file contains the structural drawing plan views with the ids replaced with page and slot in the model space.
    • wood_lfwsw_shearWall_PlanViews_with_details.dxf: This file contains the structural drawing plan views with the ids replaced with page and slot in the model space and also the pages (paper spaces) with the details.
    • details.json: This file is the details index.

  5. Review the outputs generated by the tool. If the result is not what is expected, you can repeat the process from step 2.