How do you write and document code for engineering simulations?

Writing and documenting code for engineering simulations is a vital skill for mechanical engineers who want to create, test, and optimize their designs. Engineering simulations can involve complex mathematical models, numerical methods, and software tools that require clear and consistent coding practices. In this article, you will learn some tips and best practices for writing and documenting code for engineering simulations, such as choosing a programming language, following coding standards, commenting your code, using version control, and documenting your results.

Find expert answers in this collaborative article

Selected by the community from 7 contributions. Learn more

1 Choose a programming language

The first step in writing code for engineering simulations is to choose a programming language that suits your needs and preferences. There are many programming languages available for engineering simulations, such as MATLAB, Python, C++, Fortran, and Julia. Each language has its own advantages and disadvantages, such as speed, readability, flexibility, compatibility, and support. You should consider factors such as the type and complexity of your simulation, the availability and quality of libraries and frameworks, the ease of learning and debugging, and the portability and scalability of your code.

Add your perspective

Mohammad Zaher

Simulation Specialist | Automation | Electrical and Control Engineer, MSc
Report contribution
Most powerful simulation tools that I used, they were programmed using C# and gives the user the ability to add her/his own scripts. This is also depends on which platform you want your software to run, for example for windows C# and Python are good choices. C# is reliable and used widely and there are many software developers in the market that can assist.

Like
Joseph "Cullen" O'Connor, PE

Analyzing Engineering Analysis
Report contribution
This can get complicated as you may need to use several codes or tools together. This is especially true in Design of Experiments (DoEs) or Monte Carlo analysis where you may need to rebuild a FEM with variations. One example: I often use MATLAB Simulink as a controller for an ADAMS plant model. The prompt focuses on straight coding language but many engineering tools can be pulled in through APIs or starting scripts.

Like

2 Follow coding standards

The second step in writing code for engineering simulations is to follow coding standards that make your code more readable, maintainable, and reliable. Coding standards are a set of rules and guidelines that define how to write, format, and structure your code. They can include aspects such as naming conventions, indentation, spacing, comments, variables, functions, loops, and error handling. Coding standards can vary depending on the programming language, the project, and the team. You should follow the coding standards that are commonly used and accepted by your peers and stakeholders, or create your own if none exist.

Add your perspective

Mohammad Zaher

Simulation Specialist | Automation | Electrical and Control Engineer, MSc
Report contribution
Exactly, you need to spend sometime before even starting the actual process of coding to think how your models will be? what are the parameters that would like the users to interact with and so on. Remember flexibility is good but up to a certain limit.

Like

3 Comment your code

The third step in writing code for engineering simulations is to comment your code to explain what it does, why it does it, and how it does it. Comments are lines of text that are not executed by the program, but are meant to provide information and context to the reader. Comments can help you and others understand, debug, and modify your code. You should comment your code whenever it is not obvious or intuitive what the code does or how it works. You should also comment your code to document the assumptions, parameters, inputs, outputs, and limitations of your simulation.

Add your perspective

Mohammad Zaher

Simulation Specialist | Automation | Electrical and Control Engineer, MSc
Report contribution
Not only commenting but also explaining what the role of every script or piece of code by itself. You can add manuals as well and knowledge base for every function you create and the way that it must be called in your code. This will make it really easy in the future when you have hundreds or thousands of functions.

Like

4 Use version control

The fourth step in writing code for engineering simulations is to use version control to track and manage the changes and history of your code. Version control is a system that records and stores the different versions of your code, allowing you to compare, revert, merge, and collaborate on your code. Version control can help you avoid losing or overwriting your code, fix errors and bugs, test new features and improvements, and share your code with others. You should use a version control tool, such as Git, SVN, or Mercurial, to create and maintain a repository for your code.

Add your perspective

Mohammad Zaher

Simulation Specialist | Automation | Electrical and Control Engineer, MSc
Report contribution
I have used Git before and its a great tool for version control. Think also of user managements so if you have a team of multiple programmers you need to manage the changes that they make on the road.

Like

5 Document your results

The fifth step in writing code for engineering simulations is to document your results to present and communicate your findings and conclusions. Documenting your results can involve creating and saving plots, graphs, tables, images, videos, or animations that illustrate the behavior and performance of your simulation. You should also write a report or a paper that describes the purpose, methods, results, and implications of your simulation. You should use a document format and style that is appropriate for your audience and purpose, such as LaTeX, Markdown, HTML, or PDF.

Add your perspective

Mohammad Zaher

Simulation Specialist | Automation | Electrical and Control Engineer, MSc
Report contribution
Documentation and standardization are essential for a professional and tracked development. After many years you will forget what you were thinning exactly when you wrote a certain code. What a bout a groups of developers, so it is a need to have everything documented.

Like
Joseph "Cullen" O'Connor, PE

Analyzing Engineering Analysis
Report contribution
Personally I like the LAMDA model for a front page [Look-Ask-Model-Do-Ask Again]. Recognize that full documentation should have two audiences. First, the client who wants results and boundaries. Second, the future analyst (maybe you) who's trying to re-run or recreate the analysis for the next design iteration.

Like

6 Learn from others

The sixth and final step in writing code for engineering simulations is to learn from others who have experience and expertise in your field and domain. Learning from others can help you improve your coding skills, discover new tools and techniques, and get feedback and support for your simulation. You can learn from others by reading and analyzing their code, following their tutorials and blogs, joining their online communities and forums, attending their webinars and workshops, or asking them questions and advice.

Add your perspective

7 Here’s what else to consider

This is a space to share examples, stories, or insights that don’t fit into any of the previous sections. What else would you like to add?

Add your perspective

How do you write and document code for engineering simulations?

1

2

3

4

5

6

7

1 Choose a programming language

2 Follow coding standards

3 Comment your code

4 Use version control

5 Document your results

6 Learn from others

7 Here’s what else to consider

Mechanical Engineering

Rate this article

Thanks for your feedback

More articles on Mechanical Engineering

More relevant reading

How do you write and document code for engineering simulations?

1

2

3

4

5

6

7

1 Choose a programming language

2 Follow coding standards

3 Comment your code

4 Use version control

5 Document your results

6 Learn from others

7 Here’s what else to consider

Mechanical Engineering

Rate this article

Thanks for your feedback

Explore Other Skills