Ich schreibe ein reproduzierbares Papier, und das Papier enthält Berechnungsergebnisse, die von einem Python-Skript generiert werden (ein ähnliches MATLAB-Skript generiert nahezu identische Ergebnisse). Ich bin der Meinung, dass das Papier für die Leser leichter zu verstehen wäre, wenn sie die Berechnungen im Papier mit den Berechnungen im Code in Einklang bringen könnten. Die Arbeit schlägt einen abstrakten Formalismus vor, und die Beispiele in der Arbeit sollen diesen Formalismus für die Leser (von denen viele Ingenieure sein werden) konkreter machen. Der Code wird wahrscheinlich die detaillierteste Aufzeichnung der Durchführung der Berechnungen sein, und eine Verdeutlichung könnte uns während des Überprüfungsprozesses helfen.
Hat jemand Vorschläge, wie man die Entsprechung zwischen Code und Rechenergebnissen (Zahlen, Gleichungen) klarer machen kann?
Ich dachte zum Beispiel, wenn es um Codezeilen geht, in denen verschiedene Schritte des Papiers implementiert werden, könnte ich Gleichungsnummern zitieren (es wäre erstaunlich, wenn ich den Code mit LaTeX vergleichen könnte, aber Handkennzeichnung ist in Ordnung). und ich könnte Funktionen schreiben, die den verschiedenen Beispielen und Figuren entsprechen, wie z
def example_1():
# Insert code corresponding to first example
pass
def figure_1():
# Insert code that generates Figure 1
pass
Wenn der Code groß wäre und ich nicht erklären wollte, wie viele verschiedene mathematische Methoden in der Technik tatsächlich gleich waren, würde ich mich wahrscheinlich nicht so sehr darum kümmern, den Code klarer zu machen, sondern angesichts der abstrakten Natur der Papier und die kleine Codebasis scheinen in dieser Übung einen Wert zu haben.
