Wie schreibt und dokumentiert man Code für technische Simulationen?

Bereitgestellt von KI und der LinkedIn Community

Das Schreiben und Dokumentieren von Code für technische Simulationen ist eine wichtige Fähigkeit für Maschinenbauingenieure, die ihre Konstruktionen erstellen, testen und optimieren möchten. Technische Simulationen können komplexe mathematische Modelle, numerische Methoden und Softwaretools umfassen, die klare und konsistente Codierungspraktiken erfordern. In diesem Artikel lernen Sie einige Tipps und bewährte Methoden zum Schreiben und Dokumentieren von Code für technische Simulationen kennen, z. B. die Auswahl einer Programmiersprache, das Befolgen von Codierungsstandards, das Kommentieren von Code, die Verwendung der Versionskontrolle und das Dokumentieren Ihrer Ergebnisse.

In diesem gemeinsamen Artikel finden Sie Antworten von Expert:innen.

Von der Community unter 7 Beiträgen ausgewählt. Mehr erfahren

1 Wählen Sie eine Programmiersprache

Der erste Schritt beim Schreiben von Code für technische Simulationen besteht darin, eine Programmiersprache auszuwählen, die Ihren Anforderungen und Vorlieben entspricht. Für technische Simulationen stehen viele Programmiersprachen zur Verfügung, z. B. MATLAB, Python, C++, Fortran und Julia. Jede Sprache hat ihre eigenen Vor- und Nachteile, wie z. B. Geschwindigkeit, Lesbarkeit, Flexibilität, Kompatibilität und Unterstützung. Sie sollten Faktoren wie die Art und Komplexität Ihrer Simulation, die Verfügbarkeit und Qualität von Bibliotheken und Frameworks, die einfache Erlernbarkeit und das Debuggen sowie die Portabilität und Skalierbarkeit Ihres Codes berücksichtigen.

Fügen Sie Ihre Sichtweise hinzu

Mohammad Zaher

Simulation Specialist | Automation | Electrical and Control Engineer, MSc
Beitrag melden
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.

Übersetzt

Gefällt mir
Joseph "Cullen" O'Connor, PE

Analyzing Engineering Analysis
Beitrag melden
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.

Übersetzt

Gefällt mir

2 Befolgen Sie die Codierungsstandards

Der zweite Schritt beim Schreiben von Code für technische Simulationen besteht darin, Codierungsstandards zu befolgen, die Ihren Code lesbarer, wartbarer und zuverlässiger machen. Codierungsstandards sind eine Reihe von Regeln und Richtlinien, die definieren, wie Sie Ihren Code schreiben, formatieren und strukturieren. Sie können Aspekte wie Namenskonventionen, Einrückung, Abstände, Kommentare, Variablen, Funktionen, Schleifen und Fehlerbehandlung umfassen. Die Codierungsstandards können je nach Programmiersprache, Projekt und Team variieren. Sie sollten die Codierungsstandards befolgen, die von Ihren Kollegen und Stakeholdern allgemein verwendet und akzeptiert werden, oder Ihre eigenen erstellen, wenn keine vorhanden sind.

Fügen Sie Ihre Sichtweise hinzu

Mohammad Zaher

Simulation Specialist | Automation | Electrical and Control Engineer, MSc
Beitrag melden
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.

Übersetzt

Gefällt mir

3 Kommentieren Sie Ihren Code

Der dritte Schritt beim Schreiben von Code für technische Simulationen besteht darin, den Code zu kommentieren, um zu erklären, was er tut, warum er es tut und wie er es tut. Kommentare sind Textzeilen, die nicht vom Programm ausgeführt werden, sondern dem Leser Informationen und Kontext bieten sollen. Kommentare können Ihnen und anderen helfen, Ihren Code zu verstehen, zu debuggen und zu ändern. Sie sollten Ihren Code kommentieren, wenn es nicht offensichtlich oder intuitiv ist, was der Code tut oder wie er funktioniert. Sie sollten Ihren Code auch kommentieren, um die Annahmen, Parameter, Eingaben, Ausgaben und Einschränkungen Ihrer Simulation zu dokumentieren.

Fügen Sie Ihre Sichtweise hinzu

Mohammad Zaher

Simulation Specialist | Automation | Electrical and Control Engineer, MSc
Beitrag melden
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.

Übersetzt

Gefällt mir

4 Verwenden der Versionskontrolle

Der vierte Schritt beim Schreiben von Code für technische Simulationen besteht darin, die Versionskontrolle zu verwenden, um die Änderungen und den Verlauf Ihres Codes zu verfolgen und zu verwalten. Die Versionskontrolle ist ein System, das die verschiedenen Versionen Ihres Codes aufzeichnet und speichert, sodass Sie Ihren Code vergleichen, zurücksetzen, zusammenführen und gemeinsam bearbeiten können. Die Versionskontrolle kann Ihnen dabei helfen, den Verlust oder das Überschreiben Ihres Codes zu vermeiden, Fehler und Bugs zu beheben, neue Funktionen und Verbesserungen zu testen und Ihren Code für andere freizugeben. Sie sollten ein Versionskontrolltool wie Git, SVN oder Mercurial verwenden, um ein Repository für Ihren Code zu erstellen und zu verwalten.

Fügen Sie Ihre Sichtweise hinzu

Mohammad Zaher

Simulation Specialist | Automation | Electrical and Control Engineer, MSc
Beitrag melden
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.

Übersetzt

Gefällt mir

5 Dokumentieren Sie Ihre Ergebnisse

Der fünfte Schritt beim Schreiben von Code für technische Simulationen besteht darin, Ihre Ergebnisse zu dokumentieren, um Ihre Ergebnisse und Schlussfolgerungen zu präsentieren und zu kommunizieren. Das Dokumentieren Ihrer Ergebnisse kann das Erstellen und Speichern von Diagrammen, Diagrammen, Tabellen, Bildern, Videos oder Animationen umfassen, die das Verhalten und die Leistung Ihrer Simulation veranschaulichen. Sie sollten auch einen Bericht oder eine Arbeit schreiben, in der der Zweck, die Methoden, die Ergebnisse und die Auswirkungen Ihrer Simulation beschrieben werden. Sie sollten ein Dokumentformat und einen Dokumentstil verwenden, die für Ihre Zielgruppe und Ihren Zweck geeignet sind, z. B. LaTeX, Markdown, HTML oder PDF.

Fügen Sie Ihre Sichtweise hinzu

Mohammad Zaher

Simulation Specialist | Automation | Electrical and Control Engineer, MSc
Beitrag melden
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.

Übersetzt

Gefällt mir
Joseph "Cullen" O'Connor, PE

Analyzing Engineering Analysis
Beitrag melden
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.

Übersetzt

Gefällt mir

6 Von anderen lernen

Der sechste und letzte Schritt beim Schreiben von Code für technische Simulationen besteht darin, von anderen zu lernen, die Erfahrung und Fachwissen in Ihrem Bereich und Ihrer Domäne haben. Wenn Sie von anderen lernen, können Sie Ihre Programmierkenntnisse verbessern, neue Tools und Techniken entdecken und Feedback und Unterstützung für Ihre Simulation erhalten. Sie können von anderen lernen, indem Sie ihren Code lesen und analysieren, ihren Tutorials und Blogs folgen, ihren Online-Communities und Foren beitreten, an ihren Webinaren und Workshops teilnehmen oder ihnen Fragen und Ratschläge stellen.

Fügen Sie Ihre Sichtweise hinzu

7 Hier ist, was Sie sonst noch beachten sollten

Dies ist ein Ort, an dem Sie Beispiele, Geschichten oder Erkenntnisse teilen können, die in keinen der vorherigen Abschnitte passen. Was möchten Sie noch hinzufügen?

Fügen Sie Ihre Sichtweise hinzu

Maschinenbau

+ Folgen

Diesen Artikel bewerten

Wir haben diesen Artikel mithilfe von KI erstellt. Wie finden Sie ihn?

Sehr gut Geht so

Diesen Artikel melden

Alle anzeigen

Wie schreibt und dokumentiert man Code für technische Simulationen?

1

2

3

4

5

6

7

1 Wählen Sie eine Programmiersprache

2 Befolgen Sie die Codierungsstandards

3 Kommentieren Sie Ihren Code

4 Verwenden der Versionskontrolle

5 Dokumentieren Sie Ihre Ergebnisse

6 Von anderen lernen

7 Hier ist, was Sie sonst noch beachten sollten

Maschinenbau

Diesen Artikel bewerten

Vielen Dank für Ihr Feedback

Weitere Artikel zu Maschinenbau

Relevantere Lektüre

Wie schreibt und dokumentiert man Code für technische Simulationen?

1

2

3

4

5

6

7

1 Wählen Sie eine Programmiersprache

2 Befolgen Sie die Codierungsstandards

3 Kommentieren Sie Ihren Code

4 Verwenden der Versionskontrolle

5 Dokumentieren Sie Ihre Ergebnisse

6 Von anderen lernen

7 Hier ist, was Sie sonst noch beachten sollten

Maschinenbau

Diesen Artikel bewerten

Vielen Dank für Ihr Feedback

Andere Kenntnisse ansehen