Quick Design Overview
SkyCiv Quick Design is a powerful tool designed specifically for structural engineers. With a simple cloud-based IDE platform and an intuitive frontend UI, Quick Design streamlines the design process and makes it easy to create accurate and reliable design checks and free calculators.
Quick Design Files#
SkyCiv Quick Design runs off the following files.
| File | Required | Description |
|---|---|---|
| config.json | TRUE | Contains meta information for the calculator and a list of all the input variables your calculator uses. |
| calculate.js | TRUE | Logic layer of your calculator. Takes the current input of your calculator and returns the results. The report is also built in this file. |
| s3d_integration.js | FALSE | Required to integrate your calculator wit S3D. Takes the model and analysis results from S3D and transforms these into input to be ran in your calculator. |
| ui.js | FALSE | Allows you to dynamically adjust your calculator's user interface using jQuery or equivalent DOM manipulation with JavaScript. |
| renderer.js | FALSE | Allows you to add a 3D rendering capabilities to your calculator using the SkyCiv Renderer. |
Quick Design Helpers#
Quick Design Libraries#
Unit System#
To learn about standard unit system and conversion supported in Quick Design check out this page.
Quick Start Guide#
You can either use the Draft capabilities built in to the Quick Design UI, or start with an existing repo. Having a repo is helpful as you can use the git repo and a starting basis for your code. Here's how to create your own repo:
- Visit the following project in BitBucket: Quick Design Project
- Start a new project and import from the below template on GitHub:
- Give your new repo a unique name. It should look something like this:
You can then clone the repo to your computer and use git to track and update your changes. When you want to deploy, ask Jake to deploy the calculations to the platform.
Test Files#
SkyCiv Quick Design framework includes supports the ability for users to include and run test files with their calculators. Test files can be easily accessed and executed by any user within the SkyCiv Quick Design framework.
As a developer, you have the ability to create your own test files directly within the Quick Design Framework. This feature allows you to ensure the accuracy and reliability of your calculations before sharing them with other users.
If you are interested in adding your calculator packs to the public SkyCiv Library, please note that it is required to provide a sufficient number of test files along with their associated verification. This ensures that your calculations meet the high standards of accuracy and precision expected by SkyCiv users.
Template Repo#
To help you get started, SkyCiv has created a template repository that can be downloaded directly from GitHub.
This repository serves as a starting point for your calculator development, and contains basic files and templates that can be modified to suit your specific needs. By using this template, you can save time and effort in setting up your development environment and focus on the core functionality of your calculator.
To download the template repository, simply visit the following link on GitHub. Once you have downloaded the repository, you can customize the files and templates according to your desired functionality and design.
Category Naming Convention#
To help keep things a bit neater. Numbers before the design calc will provide a category, based on the following. The same category key should be used. This should be consistent with the category key in your meta.
| Code | Category | Identifier |
|---|---|---|
| 0xxx | Samples and Examples | samples |
| 1xxx | Analysis | analysis |
| 2xxx | Steel, CFS and Aluminium | |
| 20xx | Hot Rolled | hot-rolled |
| 23xx | CFS | cfs |
| 26xx | Aluminium | alum |
| 3xxx | Concrete and Masonry | |
| 30xx | Concrete | concrete |
| 35xx | Masonry | masonry |
| 4xxx | Timber | timber |
| 5000 | Costing, Quick Calculations, Estimations | |
| 6xxx | Connections, Bolts etc... | connections |
| 7xxx | Wind/Snow and Seismic Loading | loading |
| 8xxx | Available | |
| 9xxx | Clients and Custom Calcs | custom |