Saya sedang menulis makalah yang dapat direproduksi, dan makalah ini memiliki hasil komputasi yang dihasilkan oleh skrip Python (skrip MATLAB serupa menghasilkan hasil yang hampir identik). Saya merasa bahwa makalah ini akan lebih mudah dipahami oleh pembaca jika mereka dapat mencocokkan perhitungan di koran dengan perhitungan dalam kode. Karya ini mengusulkan formalisme abstrak, dan contoh-contoh di koran seharusnya membuat formalisme ini lebih konkret bagi pembaca (banyak dari mereka akan menjadi insinyur); kode mungkin akan menjadi catatan paling rinci tentang cara melakukan perhitungan, dan membuatnya jelas dapat membantu kami selama proses peninjauan.
Adakah yang punya saran tentang bagaimana membuat korespondensi antara kode dan hasil komputasi (angka, persamaan) lebih jelas?
Sebagai contoh, saya berpikir bahwa ketika sampai pada garis kode yang menerapkan berbagai langkah di koran, saya dapat mengutip angka persamaan (akan luar biasa jika saya bisa melintasi referensi antara kode dan LaTeX, tetapi pelabelan tangan mereka baik-baik saja) , dan saya bisa menulis fungsi yang sesuai dengan berbagai contoh dan angka, seperti
def example_1():
# Insert code corresponding to first example
pass
def figure_1():
# Insert code that generates Figure 1
pass
Jika kodenya besar, dan saya tidak mencoba menjelaskan bagaimana sekelompok metode matematika yang berbeda yang digunakan dalam rekayasa sebenarnya sama, saya mungkin tidak akan terlalu repot dengan membuat kode jelas, tetapi mengingat sifat abstrak dari kertas dan basis kode kecil, sepertinya ada nilai dalam latihan ini.
