Skip to content

Commit

Permalink
small formatting changes
Browse files Browse the repository at this point in the history
  • Loading branch information
billbrod committed Nov 7, 2024
1 parent 650171f commit bd65160
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions 36_ReproduciblePaper/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ the way I've heard this described is "your most important collaborator is yourse
so our topics are grouped into a couple of higher-level categories: read slide. Edaordo's going to present about the first two of these, which are the meatiest, and then I'm going to come back and finish us up. Periodically, we're going to switch tabs to show you how we've implemented these steps in our own projects.



## Get your code running on another machine

#note: the absolute minimal requirement for reproducible results is that your analysis code can run on a machine that is not your own. In the next slides I will
Expand Down Expand Up @@ -228,11 +229,10 @@ find path/to/dir/ -type f -name '*py' -exec grep --no-filename -e '^from' -e '^i
</code>
</pre>


#note: Finally, facilitate installing your code. List your direct dependecies in a requirement file, menaing the things you directly import and use. Do not pin specific python version; for more details on this check Sept sciware on pacakging. You can list your import in various way, here I added a one-linear command for that.


<ol start="6">
<ol start="7">
<li><strong>Containers?</strong></li>
<ul>
<li><strong>When Using Containers</strong>
Expand All @@ -254,6 +254,7 @@ find path/to/dir/ -type f -name '*py' -exec grep --no-filename -e '^from' -e '^i
HPC syste. On the other hand, if your installation is easy enough (pure python, standard packages), conda enviroments may be sufficient.



## Provide Necessary Information

Write a `README` file which answers the following questions:
Expand Down Expand Up @@ -295,6 +296,7 @@ Different ways of adding citations:
- Consider generating a DOI via Zenodo.



## What data to share and where?

#note: when thinking about sharing data, start with these questions.
Expand Down

0 comments on commit bd65160

Please sign in to comment.