Skip to content

Commit

Permalink
Updates for an even simpler first step
Browse files Browse the repository at this point in the history
  • Loading branch information
larsvilhuber committed Dec 31, 2023
1 parent bb19bd4 commit babfa9c
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
14 changes: 14 additions & 0 deletions 01_run_it_again.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Run it all again

The very first test is that your code must run, beginning to end, top to bottom, without error, and ideally without any user intervention. This should in principle (re)create all figures, tables, and numbers you include in your paper.


## Exceptions

### Code runs for a very long time

What happens when some of these re-runs are very long? See later in this chapter for how to handle this.

### Making the code run takes you a very long time

While the code, once set to run, can do so on its own, *you* might need to spend a lot of time getting all the various pieces to run. This should be a warning sign: if it takes you a long time to get it to run, or to manually reproduce the results, it might take others even longer. Furthermore, it may suggest that you haven't been able to re-run your own code very often, which can be correlated with fragility or even lack of reproducibility. We address this partially in the [next section](hands-off-running).
3 changes: 2 additions & 1 deletion 01_hands_off_running.md → 02_hands_off_running.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(hands-off-running)=
# Hands-off running

The very first test is that your code must run, beginning to end, top to bottom, without error, and ideally without any user intervention. This should in principle (re)create all figures, tables, and numbers you include in your paper.
Expand All @@ -8,7 +9,7 @@ Many users may not be set up to run in one single top-to-bottom run. It helps to
We have seen users who appear to highlight code and to run it interactively, in pieces, using the program file as a kind of notepad. This is not reproducible, and should be avoided. It is fine for debugging.
```

## Some simple examples of main files
## Examples



Expand Down
File renamed without changes.

0 comments on commit babfa9c

Please sign in to comment.