Piszę powtarzalny artykuł, a artykuł ma wyniki obliczeń generowane przez skrypt Pythona (podobny skrypt MATLAB generuje prawie identyczne wyniki). Wydaje mi się, że artykuł byłby łatwiejszy do zrozumienia dla czytelników, gdyby mogli dopasować obliczenia w artykule do obliczeń w kodzie. Praca proponuje abstrakcyjny formalizm, a przykłady w artykule mają uczynić ten formalizm bardziej konkretnym dla czytelników (z których wielu będzie inżynierami); kod będzie prawdopodobnie najdokładniejszym zapisem sposobu wykonywania obliczeń, a jego wyjaśnienie może nam pomóc w procesie przeglądu.
Czy ktoś ma jakieś sugestie, jak wyjaśnić zgodność między kodem a wynikami obliczeniowymi (liczby, równania)?
Na przykład myślałem, że jeśli chodzi o wiersze kodu implementujące różne kroki w dokumencie, mogę zacytować liczby równań (byłoby niesamowite, gdybym mógł powiązać kod z LaTeX-em, ale ręczne etykietowanie ich jest w porządku) , i mógłbym pisać funkcje odpowiadające różnym przykładom i rysunkom, takie jak
def example_1():
# Insert code corresponding to first example
pass
def figure_1():
# Insert code that generates Figure 1
passGdyby kod był duży, a ja nie próbowałem wyjaśnić, jak wiele różnych metod matematycznych stosowanych w inżynierii było w rzeczywistości takich samych, prawdopodobnie nie zawracałbym sobie głowy wyjaśnianiem kodu, ale biorąc pod uwagę abstrakcyjną naturę papier i mała podstawa kodu, wydaje się, że w tym ćwiczeniu może być wartość.
