Я пишу відтворювальний папір, і в папері є обчислювальні результати, які генеруються сценарієм Python (подібний сценарій MATLAB генерує майже однакові результати). Я відчуваю, що папір буде легше зрозуміти читачам, якби вони могли зіставити обчислення в роботі з розрахунками в коді. У роботі пропонується абстрактний формалізм, а приклади у статті повинні зробити цей формалізм більш конкретним для читачів (багато з яких будуть інженерами); код, мабуть, буде найбільш детальним записом про те, як виконати обчислення, і, зрозумівши, може допомогти нам у процесі перегляду.
Чи є хтось із пропозицій, як зробити чіткіше відповідність між кодом та результатами обчислень (цифри, рівняння)?
Наприклад, я думав, що коли мова заходить про рядки коду, що реалізують різні етапи в роботі, я можу навести числа рівнянь (було б дивно, якби я міг перекреслити посилання між кодом та LaTeX, але маркування їх вручну нормально) , і я можу записати функції, що відповідають різним прикладам і малюнкам, таким як
def example_1():
# Insert code corresponding to first example
pass
def figure_1():
# Insert code that generates Figure 1
pass
Якби код був великим, і я не намагався пояснити, як купу різних математичних методів, що використовуються в техніці, насправді були однаковими, я, мабуть, не настільки б переймався тим, щоб зробити код зрозумілим, але зважаючи на абстрактний характер папір та невелика база коду, здається, що в цій вправі може бути значення.
