Skip to content

Commit cc479d8

Browse files
author
Quarto GHA Workflow Runner
committed
Built site for gh-pages
1 parent e510c61 commit cc479d8

File tree

15 files changed

+963
-99
lines changed

15 files changed

+963
-99
lines changed

.nojekyll

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
4d716032
1+
e1d46ad2

evaluation/artefacts.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ <h2 class="anchored" data-anchor-id="best-practice-audit">Best practice audit</h
288288
<td>Code Testing</td>
289289
<td>Is there any evidence of tests that have been applied to the code to check that it functions correctly?</td>
290290
<td style="text-align: center;">❌ Not met</td>
291-
<td>No tests found</td>
291+
<td>No tests found for DES model (tests for Monte Carlo model are available in GitLab repository)</td>
292292
</tr>
293293
<tr class="even">
294294
<td>Local execution</td>

evaluation/badges.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -243,10 +243,10 @@ <h1 class="title">Badges</h1>
243243

244244

245245
<p>This page evaluates the extent to which the author-published research artefacts meet the criteria of badges related to reproducibility from various organisations and journals.</p>
246-
<p><em>Caveat: Please note that these criteria are based on available information about each badge online, and that we have allowed troubleshooting for execution and reproduction. We cannot guarantee that the badges below would have been awarded in practice by these journals.</em></p>
246+
<p><em>Caveat: Please note that these criteria are based on available information about each badge online, and that we have likely differences in our procedure (e.g.&nbsp;allowed troubleshooting for execution and reproduction, not under tight time pressure to complete). We cannot guarantee that the badges below would have been awarded in practice by these journals.</em></p>
247247
<section id="criteria" class="level2">
248248
<h2 class="anchored" data-anchor-id="criteria">Criteria</h2>
249-
<div id="6fa3f8fc" class="cell" data-execution_count="1">
249+
<div id="c914c09b" class="cell" data-execution_count="1">
250250
<details class="code-fold">
251251
<summary>Code</summary>
252252
<div class="sourceCode cell-code" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> IPython.display <span class="im">import</span> display, Markdown</span>
@@ -378,7 +378,7 @@ <h2 class="anchored" data-anchor-id="criteria">Criteria</h2>
378378
</section>
379379
<section id="badges" class="level2">
380380
<h2 class="anchored" data-anchor-id="badges">Badges</h2>
381-
<div id="a2af8233" class="cell" data-execution_count="2">
381+
<div id="724f2e6c" class="cell" data-execution_count="2">
382382
<details class="code-fold">
383383
<summary>Code</summary>
384384
<div class="sourceCode cell-code" id="cb2"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Full badge names</span></span>

evaluation/logbook.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ <h5 class="quarto-listing-category-title">Categories</h5><div class="quarto-list
248248

249249
<div class="quarto-listing quarto-listing-container-default" id="listing-listing">
250250
<div class="list quarto-listing-default">
251-
<div class="quarto-post image-right" data-index="0" data-categories="guidelines" data-listing-date-sort="1717545600000" data-listing-file-modified-sort="1717668622397" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="7" data-listing-word-count-sort="1345">
251+
<div class="quarto-post image-right" data-index="0" data-categories="guidelines" data-listing-date-sort="1717545600000" data-listing-file-modified-sort="1717688914174" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="8" data-listing-word-count-sort="1439">
252252
<div class="thumbnail">
253253
<p><a href="../evaluation/posts/2024_06_05/index.html" class="no-external"></a></p><a href="../evaluation/posts/2024_06_05/index.html" class="no-external">
254254
<div class="listing-item-img-placeholder card-img-top" >&nbsp;</div>
@@ -281,7 +281,7 @@ <h3 class="no-anchor listing-title">
281281
</a>
282282
</div>
283283
</div>
284-
<div class="quarto-post image-right" data-index="1" data-categories="guidelines" data-listing-date-sort="1717459200000" data-listing-file-modified-sort="1717668622397" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="4" data-listing-word-count-sort="635">
284+
<div class="quarto-post image-right" data-index="1" data-categories="guidelines" data-listing-date-sort="1717459200000" data-listing-file-modified-sort="1717688914174" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="4" data-listing-word-count-sort="696">
285285
<div class="thumbnail">
286286
<p><a href="../evaluation/posts/2024_06_04/index.html" class="no-external"></a></p><a href="../evaluation/posts/2024_06_04/index.html" class="no-external">
287287
<div class="listing-item-img-placeholder card-img-top" >&nbsp;</div>
@@ -314,7 +314,7 @@ <h3 class="no-anchor listing-title">
314314
</a>
315315
</div>
316316
</div>
317-
<div class="quarto-post image-right" data-index="2" data-categories="reproduce" data-listing-date-sort="1717372800000" data-listing-file-modified-sort="1717668622393" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="5" data-listing-word-count-sort="879">
317+
<div class="quarto-post image-right" data-index="2" data-categories="reproduce" data-listing-date-sort="1717372800000" data-listing-file-modified-sort="1717688914170" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="5" data-listing-word-count-sort="879">
318318
<div class="thumbnail">
319319
<p><a href="../evaluation/posts/2024_06_03/index.html" class="no-external"></a></p><a href="../evaluation/posts/2024_06_03/index.html" class="no-external">
320320
<p class="card-img-top"><img src="../original_study/article_fig2.png" class="thumbnail-image card-img"/></p>
@@ -347,7 +347,7 @@ <h3 class="no-anchor listing-title">
347347
</a>
348348
</div>
349349
</div>
350-
<div class="quarto-post image-right" data-index="3" data-categories="reproduce" data-listing-date-sort="1716508800000" data-listing-file-modified-sort="1717668622393" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="458">
350+
<div class="quarto-post image-right" data-index="3" data-categories="reproduce" data-listing-date-sort="1716508800000" data-listing-file-modified-sort="1717688914170" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="458">
351351
<div class="thumbnail">
352352
<p><a href="../evaluation/posts/2024_05_24/index.html" class="no-external"></a></p><a href="../evaluation/posts/2024_05_24/index.html" class="no-external">
353353
<p class="card-img-top"><img src="posts/2024_05_24/figure_1a.png" class="thumbnail-image card-img"/></p>
@@ -380,7 +380,7 @@ <h3 class="no-anchor listing-title">
380380
</a>
381381
</div>
382382
</div>
383-
<div class="quarto-post image-right" data-index="4" data-categories="read,reproduce" data-listing-date-sort="1716422400000" data-listing-file-modified-sort="1717668622389" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="13" data-listing-word-count-sort="2543">
383+
<div class="quarto-post image-right" data-index="4" data-categories="read,reproduce" data-listing-date-sort="1716422400000" data-listing-file-modified-sort="1717688914166" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="13" data-listing-word-count-sort="2543">
384384
<div class="thumbnail">
385385
<p><a href="../evaluation/posts/2024_05_23/index.html" class="no-external"></a></p><a href="../evaluation/posts/2024_05_23/index.html" class="no-external">
386386
<p class="card-img-top"><img src="../original_study/article_fig4.png" class="thumbnail-image card-img"/></p>
@@ -416,7 +416,7 @@ <h3 class="no-anchor listing-title">
416416
</a>
417417
</div>
418418
</div>
419-
<div class="quarto-post image-right" data-index="5" data-categories="setup,read,scope" data-listing-date-sort="1716336000000" data-listing-file-modified-sort="1717668622385" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="9" data-listing-word-count-sort="1786">
419+
<div class="quarto-post image-right" data-index="5" data-categories="setup,read,scope" data-listing-date-sort="1716336000000" data-listing-file-modified-sort="1717688914162" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="9" data-listing-word-count-sort="1786">
420420
<div class="thumbnail">
421421
<p><a href="../evaluation/posts/2024_05_22/index.html" class="no-external"></a></p><a href="../evaluation/posts/2024_05_22/index.html" class="no-external">
422422
<p class="card-img-top"><img src="../original_study/article_fig1.png" class="thumbnail-image card-img"/></p>

evaluation/posts/2024_05_22/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,7 @@ <h3 class="anchored" data-anchor-id="untimed-uploading-to-zenodo">Untimed: Uploa
475475
</section>
476476
<section id="timings" class="level2">
477477
<h2 class="anchored" data-anchor-id="timings">Timings</h2>
478-
<div id="5f23259d" class="cell" data-execution_count="1">
478+
<div id="7fbf2d46" class="cell" data-execution_count="1">
479479
<div class="sourceCode cell-code" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> sys</span>
480480
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a>sys.path.append(<span class="st">'../'</span>)</span>
481481
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> timings <span class="im">import</span> calculate_times</span>

evaluation/posts/2024_05_23/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -547,7 +547,7 @@ <h3 class="anchored" data-anchor-id="reproduction-2">15.23-16.35 Reproduction</h
547547
</section>
548548
<section id="timings" class="level2">
549549
<h2 class="anchored" data-anchor-id="timings">Timings</h2>
550-
<div id="43ceb09c" class="cell" data-execution_count="1">
550+
<div id="82579629" class="cell" data-execution_count="1">
551551
<div class="sourceCode cell-code" id="cb5"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> sys</span>
552552
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a>sys.path.append(<span class="st">'../'</span>)</span>
553553
<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> timings <span class="im">import</span> calculate_times</span>

evaluation/posts/2024_05_24/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ <h3 class="anchored" data-anchor-id="untimed-exploring-methods-for-overlaying-fi
290290
<p>Exploring methods for overlaying figures. Not timed as not about reproduction of this study, but about how we are going to do this each time when reproducing.</p>
291291
<p>Decided that it’s not helpful to do this - spend more time fiddling around with getting them to resize and overlay correctly - and that the simplest option here would be to compare by eye.</p>
292292
<p>If timed, 13.33-13.57.</p>
293-
<div id="0ec7ad63" class="cell" data-execution_count="1">
293+
<div id="476be9c2" class="cell" data-execution_count="1">
294294
<div class="sourceCode cell-code" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> cv2</span>
295295
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> matplotlib.pyplot <span class="im">as</span> plt</span>
296296
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a></span>
@@ -312,7 +312,7 @@ <h3 class="anchored" data-anchor-id="untimed-exploring-methods-for-overlaying-fi
312312
</div>
313313
</div>
314314
</div>
315-
<div id="5bb31d96" class="cell" data-execution_count="2">
315+
<div id="acb415d2" class="cell" data-execution_count="2">
316316
<div class="sourceCode cell-code" id="cb2"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Overlay transparently</span></span>
317317
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a>combined <span class="op">=</span> cv2.addWeighted(original,<span class="fl">0.4</span>,overlay_resize,<span class="fl">0.1</span>,<span class="dv">0</span>)</span>
318318
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a></span>
@@ -332,7 +332,7 @@ <h3 class="anchored" data-anchor-id="untimed-exploring-methods-for-overlaying-fi
332332
</section>
333333
<section id="timings" class="level2">
334334
<h2 class="anchored" data-anchor-id="timings">Timings</h2>
335-
<div id="191145ef" class="cell" data-execution_count="3">
335+
<div id="e7e5df94" class="cell" data-execution_count="3">
336336
<div class="sourceCode cell-code" id="cb3"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> sys</span>
337337
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a>sys.path.append(<span class="st">'../'</span>)</span>
338338
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> timings <span class="im">import</span> calculate_times</span>

evaluation/posts/2024_06_03/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ <h3 class="anchored" data-anchor-id="tidying-the-notebook-and-creating-reproduct
386386
</section>
387387
<section id="timings" class="level2">
388388
<h2 class="anchored" data-anchor-id="timings">Timings</h2>
389-
<div id="5a19ef86" class="cell" data-execution_count="1">
389+
<div id="489e25fe" class="cell" data-execution_count="1">
390390
<div class="sourceCode cell-code" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> sys</span>
391391
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a>sys.path.append(<span class="st">'../'</span>)</span>
392392
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> timings <span class="im">import</span> calculate_times</span>

evaluation/posts/2024_06_04/index.html

+4
Original file line numberDiff line numberDiff line change
@@ -235,18 +235,21 @@ <h3 class="anchored" data-anchor-id="badges">Badges</h3>
235235
<li>Required some minor changes to environment in order for scripts to run</li>
236236
<li>However, not certain whether the badges would allow minor troubleshooting (or major troubleshooting) in order for a script to run?</li>
237237
<li>By my criteria (allowing troubleshooting) this would be fine. The step up from this criteria is reproduction (which I again allow troubleshooting) - so it would make sense that this is getting it to run, whilst next step is getting sufficiently similar results. May just need to add a <strong>caveat</strong> that this is with troubleshooting allowed (which may not be journal policy) - in same way that caveat, this is my interpretation of badges from available information and cannot guarantee would or would not be awarded.</li>
238+
<li><strong>Chat with Tom:</strong> Fine to just caveat.</li>
238239
</ul></li>
239240
<li><code>hour</code>: Reproduced within approximately one hour (excluding compute time)
240241
<ul>
241242
<li>Took longer than an hour, but I wasn’t trying to get it done in that time</li>
242243
<li>If I hadn’t spent time reading and documenting and fiddling with the seeds, then I anticipate I could’ve run it within an hour</li>
243244
<li>However, <strong>I’m assuming to follow our process and fail it</strong> (for consistency with how we are working and timing)</li>
245+
<li><strong>Chat with Tom:</strong> Fine to just caveat.</li>
244246
</ul></li>
245247
<li><code>documentation_readme</code>: “Artefacts are clearly documented and accompanied by a README file with step-by-step instructions on how to reproduce results in the manuscript”
246248
<ul>
247249
<li>I wouldn’t say it explicitly meets this criteria</li>
248250
<li>Although it was simple enough that it could do it anyway - directed me to notebook, run that, job done.</li>
249251
<li><strong>Uncertain on this one</strong></li>
252+
<li>Uncertainty is fine - just make a choice, and justify and document that choice in the logbook</li>
250253
</ul></li>
251254
</ul>
252255
</section>
@@ -263,6 +266,7 @@ <h3 class="anchored" data-anchor-id="sharing-research-artefacts">Sharing researc
263266
<li>Do they meet criteria is changes are made to a repository <strong>after</strong> publications? (this is general, not specific to this test-run)
264267
<ul>
265268
<li>Example: If we asked them to add a licence - do we then fail them on that? I’m presuming so?</li>
269+
<li><strong>Chat with Tom:</strong> Agree that it should be based on stuff prior to publication.</li>
266270
</ul></li>
267271
</ul>
268272
</section>

evaluation/posts/2024_06_05/index.html

+6-3
Original file line numberDiff line numberDiff line change
@@ -270,17 +270,19 @@ <h3 class="anchored" data-anchor-id="evaluation-against-reporting-guidelines-pt.
270270
<li><code>2.5.5 Components - entry and exit points</code>
271271
<ul>
272272
<li><strong>Get a second opinion</strong> on this - have I been too harsh?</li>
273+
<li><strong>Chat with Tom</strong> - fine, just describe and justify.</li>
273274
</ul></li>
274275
<li><code>5.1 Software or programming language</code>: “Where frameworks and libraries have been used provide all details including version numbers.”
275276
<ul>
276277
<li>This part of criteria is <strong>not</strong> in the report, but is in the linked code.</li>
277278
<li>Passed them anyway, as other parts of this criteria (OS, version, build DES software, Python) were provided - and also, wouldn’t think you would put this extra level of information in the report?</li>
279+
<li><strong>Chat with Tom</strong> - take a consistent approach (only basing on article) and therefore partially met if missing this (as purpose is to learn what people do and do not do)</li>
278280
</ul></li>
279281
<li><code>5.3 Model execution</code>: “State the event processing mechanism used e.g.&nbsp;three phase, event, activity, process interaction.”
280282
<ul>
281283
<li><strong>Feeling quite unclear on this</strong>. Did some research onto it but that hasn’t really cleared it up…</li>
282284
<li>Based answer on Tom’s, but don’t feel confident guessing at this for future ones</li>
283-
<li>Any <strong>recommended resources</strong> to explain this?</li>
285+
<li><strong>Chat with Tom</strong> - can often find based on package used, but do fail if not explicitly stated method in text</li>
284286
</ul></li>
285287
</ul>
286288
<div class="callout callout-style-simple callout-note no-icon callout-titled">
@@ -315,6 +317,7 @@ <h3 class="anchored" data-anchor-id="evaluation-against-reporting-guidelines-pt.
315317
<li><code>15 Is the model generalizability issue discussed?</code>
316318
<ul>
317319
<li>Have I been too harsh on this one? Or do we want it to be explicitly addressed?</li>
320+
<li><strong>Chat with Tom</strong> - fine, as before, just justify choice made</li>
318321
</ul></li>
319322
</ul>
320323
</section>
@@ -384,7 +387,7 @@ <h3 class="anchored" data-anchor-id="comparison-of-my-stress-des-against-the-ori
384387
<h3 class="anchored" data-anchor-id="comparing-best-practice-audit-results-with-monks-and-harper">Comparing best practice audit results with Monks and Harper</h3>
385388
<p>Compared my decisions for the best practice audit against those made in Monks and Harper.</p>
386389
<p>Their GitHub is <a href="https://github.com/TomMonks/des_sharing_lit_review">TomMonks/des_sharing_lit_review</a>, which provides the file <code>bp_audit.zip</code>. I used the provided code to clean this and saved it as <code>bp_audit_clean.csv</code>, which can then view here:</p>
387-
<div id="84e17fa1" class="cell" data-execution_count="1">
390+
<div id="018825c9" class="cell" data-execution_count="1">
388391
<div class="sourceCode cell-code" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> pandas <span class="im">as</span> pd</span>
389392
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a></span>
390393
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="co"># Import review results</span></span>
@@ -528,7 +531,6 @@ <h3 class="anchored" data-anchor-id="comparing-best-practice-audit-results-with-
528531
<ul>
529532
<li>I said yes as its within Zenodo, but they said no</li>
530533
<li>I have amended my answer, as on reflection, I agree that this should be part of the artefacts themselves, and not just meta-data on Zenodo, as the artefacts are what you download, but have kept this as “partially met”</li>
531-
<li><strong>Get a second opinion on this</strong></li>
532534
</ul></li>
533535
<li>Informal dependency management
534536
<ul>
@@ -538,6 +540,7 @@ <h3 class="anchored" data-anchor-id="comparing-best-practice-audit-results-with-
538540
<ul>
539541
<li>They said yes but I said no</li>
540542
<li><strong>Ask tom what they felt was evidence of testing?</strong></li>
543+
<li><strong>Chat with Tom</strong> - evidence was in GitLab rather than Zenodo (but was for the vehicle model, so evaluation remains the same)</li>
541544
</ul></li>
542545
</ul>
543546
</section>

0 commit comments

Comments
 (0)