Simülasyonlarımın sonuçlarının ve makalemdeki sonuçların her zaman senkronize olduğundan nasıl emin olabilirim?

Makalelerimden birinde bazı rakamlara ek olarak bazı sayısal sonuçları da listeliyorum. Yapmak istediğim, makalemdeki sayısal sonuçların daima kodla aynı olduğundan emin olmak. Şu anda, simülasyon çıktılarımdan elde ettiğim sayısal sonuçları doğrudan son derece basit ve düşük teknolojili, ancak hata eğilimli kağıda kopyalarım, çünkü sonuçları yanlış kopyalayabilir veya kağıt sonuçlarını eşitlemeyi unutabilirim. kod çıkışı.

Makalelerimde alıntı yaptığım sayısal sonuçları kodum tarafından oluşturulan sonuçlarla senkronize etmenin iyi bir yolu var mı? (Burada, kodun çalıştırılmasının, kağıdımı güncellemek istediğimde yapmanın kolay ve pratik olduğunu farz ediyorum.) Bu sayısal sonuçların, kendilerini tablo biçiminde vermeleri gerekmez. Bazen yazılarda tablolarım var ama daha genel olarak denklemlerde sayılar olarak listelenen simülasyon parametrelerim var . Bir örnek şöyle bir şey olurdu:

ilk koşul ilk elemanlarını , sıradan diferansiyel denklem sistemlerini sayısal olarak bütünleştiren bir simülasyonda kullandığım gerçek parametrelerle değiştirmek istiyorum. Bu örnek gibi bir kereye mahsus veriler için bir tablo kullanmak gereğinden fazla abartılı ve daha fazla mürekkep gibi görünüyor.$\mathbf{y}^{*}$

Rakamların daha kolay bir durum olduğunu tahmin ediyorum: Belge "inşa edildiğinde" (LaTeX kaynağından, Markdown'dan, RST'den vb.), Kodu uygulayarak derleme işlemini başlatır. Ancak, insanlar simülasyonlarımın ürettiği rakamları makalemle senkronize etmek için daha iyi önerilerde bulunursa, onları duymayı çok isterim.

Bazı yorumların öne sürdüğü gibi, bu yaklaşım uzun zamandır R topluluğuna dayanarak Sweaveve daha yakın zamanda geliştirilerek geliştirilmiştir knitr. Açıkçası, bu yaklaşım şu anda dile özgü olmanın dezavantajına sahip olmakla birlikte, akademik çalışmalarda düzenli olarak kullanılması avantajına sahiptir.

Sweave'in gerçek yayınlarda kullanımı

• Biyoistatistik Dergisi , bu gönderileri teşvik ve bağıl standart editörü kod ve veri çalıştırmak ve bu sonuçları elde etmek mümkün olmuştur hangi akademik kağıtlarında bir Kitemark® harfi "R" yerleştirir.
• Esasen R-Journal'daki bütün yayınlar Sweave üzerine inşa edilmiştir.

Elbette daha yaygın Sweave / knitr kullanıcıları çoğu dergiye sadece son çıktıyı sunmakta ve bu yöntemlerin sonuçları gerçekten ortaya koyduğuna dair kişisel bir güven duymaktadır. Aynı şekilde sweave sık sık profesyonel konuşmalarda vb. Slaytlar oluşturmak için kullanılır.

Faydalı özellikler

Pratikte faydalı olması için, böyle bir sistemin belirli özelliklere sahip olması gerekir. Kritik bir kullanıcı kitlesi ile bunların birçoğu gelişmiş knitr. Birkaç olay:

• Caching. Çıktıyı görmek için derlenmesi gereken işaretleme veya lateks gibi bir formatta yazmak, sonuçları önbelleğe alınamadığında kod dahil olmak üzere imkansız hale getirir. Akıllıca önbelleğe alma, knitryoğun kodun hata ayıklamasını, saf Rparçalardan daha kolay yapar , çünkü başarılı parçaların yeniden çalıştırılması gerekmez.

• Geçiş kodu gösterimi. Resmi bir yayında, temel kodlardan hiçbirinin çıktıda görünmesini istemeyebilirsiniz. Bu arada, okuyucunun tam olarak yazdıklarınızı görmesini istediğinizde sonuçları üreten formatta (güzel bir şekilde formatlanmış, sözdizimi ile vurgulanmış) kodun gösterilmesi genellikle değerlidir.

• Topluluk. Belki de bu yaklaşımın ev sahibi bir çözüm üzerindeki en çarpıcı avantajı, modele aşina olan ve onu geliştirmeye çalışan insan sayısıdır.

• "Hafif yayıncılık" araçları veya web üzerinde paylaşım araçları da dahil olmak üzere , knitr web sayfası demolarında birçok güzel özellik örneği bulunabilir . Bu özelliklerin birçoğu, yalnızca bu yazıyı yazarken yapacak bir şey yerine, bu yaklaşımın genel iş akışıyla daha uyumlu olmasına yardımcı olur.

Tarihsel dipnot.

Adının da belirttiği gibi Knuth'un “okuryazar programlama” larına dayanmakla birlikte, okuryazar programlamanın yazılım kodunu ve dokümantasyonu (R topluluğunda, rolün oynadığı Roxygen, köklerini farklı bir koluna kadar izleyen) bağlamaya odaklandığından vurgu oldukça farklıdır . "okuryazar programlama ağacı").

Ötesine gitmek

Prensipte, örneğin etkileşimli bir çevrimiçi platform kullanarak, tüm dokümanı düzenlemek ve yeniden derlemek zorunda kalmadan okuyucunun girdileri değiştirme ve çıktıları görme yeteneği gibi dinamik bir belgeden çok daha fazlasını sorabiliriz. XDynDocs bu yönde bir adım olabilir.

Diğer yaklaşımlar

• Dexy.it bir göz tutmak isteyebilirsiniz
• Biraz farklı bir yaklaşımda: Giderek artan sayıda ekonomi makalesi, http://www.runmycode.org/ adresindeki yayınlarla ilgili kodu barındırır ;

İstediğiniz şey "Çalıştırılabilir Belge" nin Elsivier büyük mücadelesi . Birçok yaklaşım denenmiş olsa da, hiçbiri yazarın önerebileceği kadar çekici değildir. İşte kullanılan tekniklerden birkaç örnek.

Madagaskar Projesi yaklaşımınızı benimsiyor, yapım senaryosunun içinde figürleri ve kağıdı aynı anda üreten simülasyonlar çalışıyor.

IPython Notebook , okuduğunuzda ve kalplerinizin içeriğine göre rakamlar ürettiğinizde çalışabileceğiniz bir belge sunar. (Eklentiler, Mathematica ve aynı şekilde kullanılan birçok başka çözüm gördüm)

VisTrails , hizmet odaklı bir mimari yaklaşım kullanır ve bir " tedarik " veya "iş akışı" yöneticisi sağlar. Temel olarak, kodları kaydetmek için kancaları kaydedersiniz, ardından bir iş akışı tasarlar veya işinizi yeniden üreten bir deney yaparsınız. HPC kümeleri dahil olmak üzere birçok kod türünde kullanılmıştır. Bu yaklaşımla denemeleri tekrar etmenin bir yolu olacaktır.

Dışarıda bu tip çözümlerin tonları var, ancak bunlardan etkilendiğim üç tane var. Bu zor bir problem ve ben gerçekten ele almaya bile yakın olmadığımıza inanıyorum. İnsanların kodlarını bildirileriyle yayınlamalarını bile sağlayamıyoruz, sonuçları tekrarlamalarını nasıl bekleyebiliriz?

Bu problem için başkalarının çözümlerini kullanma konusunda çok başarılı olamadım. Genelde sadece benim için çalışan ve işi halleden basit bir şey istiyorum. Bu amaçla, genellikle tüm sonuçları çalıştırma, çıktının ayrıştırma ve şekil / tabloları oluşturmanın sorumlusu olan bir python betiği yazmaya çalışıyorum.

Bazı metin biçiminde sonuçları içeren veri dosyaları oluşturmak için kodlarımı yazıyorum. Öncelikle çıktı dosyasının varlığını test ederek bu sonuçları betiğinizde tekrarlamaktan kaçınabilirsiniz (örneğin, python'da os.path.isfile ()). Sonuçlarınızı tekrar görüntülemek istiyorsanız, sadece veri dosyalarını kaldırın. Veri dosyaları varsa, o zaman bu dosyaların ayrıştırıcısını çalıştırırım. Bunun için düzenli ifadeler için python modülü çok kullanışlıdır (yeniden).

Sonra ayrıştırılan çıktıdan şekil veya tabloları oluşturdum. Lateks içindeki tablolar için, tabloyu ayrı bir dosyaya oluşturacak kodu yazabilir (.tbl uzantısı kullanırım) ve sonra bunu lateks dosyanıza dahil edebilirsiniz. Benim için anahtar 1 python betiği kullanmak. Eğer bir sürü varsa, o zaman hangisinin hangisi olduğunu ve ne yaptıklarını merak ediyorum. Bu açıklama çok belirsiz ise, size bazı örnekler gönderebilirim.

Daha da önemlisi, benim görüşüme göre, tüm sonuçlarınızı sıfırdan veya bir ay içinde sıfırdan nasıl yeniden oluşturacağınıza karar verebileceğinizden emin olmak (örneğin, hakemler bir şey eklemenizi veya değiştirmenizi istediğinde). Bu amaçla, yaptığım tüm sonuçların nasıl yeniden üretileceğine ilişkin ayrıntılı talimatlar içeren bir metin dosyası içermektir. Bunları bir başkası (bir yazar gibi) deneyerek denemeniz en iyisidir. Ayrıca, bu talimatları (ve tüm kodunuzu) hakemlere ve okuyuculara da sağlamanızı öneririm.

İşte bir örnek (aslında ortak yazarım Aron Ahmadia tarafından hazırlanmıştır).

Emacs en orgmode Babil ile birlikte o başarır. Babel çeşitli programlama ve kodlama dillerinden kod snippet'lerini çalıştırabilir; örneğin, simülasyon verilerini içeren dosyayı açıp orgmode'da LaTeX'e (ve diğer birçok biçime) dışa aktarılabilen bir tabloya koyabilir. Orgmode'daki tüm tuş kombinasyonlarına alışmak biraz zaman alıyor, fakat bir kez her şey otomatik çalışıyor.

Tüm kodunuzu çalıştırmak ucuzsa, aşağıdaki gibi düşük teknolojili bir şey yapabilirsiniz:

Belgelerinizi, biçimlendirilmiş dizelerle, bu şekilde görünecek şekilde şablonlayabilirsiniz.

"we observed a %(fractional_improvement)s increase in ..."

Buna benzeyen python komut dosyaları var

results = {"alpha"                  : run_alpha_computation(...),
           "fractional_improvement" : run_fi_computation(...), 
           ...}

Ve sonra böyle bir şey yapın

for fn in filenames:
    file = open(fn);      s = file.read();       file.close()
    file = open(fn, 'w'); file.write(s%results); file.close()

Daha sonra bunu bir Makefile'a sarabilirsiniz.

LaTeX kullanıyorsanız, nispeten düşük teknolojili bir çözüm, kodunuzun bir dosya (veya kodunuzun çıktısını filtrelemek için başka bir komut dosyası) tükürmesini sağlamaktır.

\newcommand{\myresults1}{<value>}

Ardından \inputbu dosyayı belgenize eklemek için komutu kullanabilir ve değerleri yerleştirmek için tanımlanan komutları kullanabilirsiniz.

Elsevier için çalışıyorum. Şirketim, yazarların makaleleriyle çalıştırılabilir kod parçalarını yayınlamalarını sağlamak için, dergi sayılarında Collage uygulamasını (Yürütülebilir Paper Grand Challenge'ye göre geliştirilen) kullanmaya başladı. Bu özellik, okuyucuların makalede bildirilen sonuçları yeniden üretmelerini ve yayınlanan materyalleri kendi araştırmaları için yeniden kullanmalarını kolaylaştırır. Collage, çok çeşitli açık kaynaklı ve özel yazılımları destekler; Daha fazla bilgi bilgilendirme videoda bulunabilir burada ve en Kolaj Yazma Çevre Sitesi .