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