Skip to content

Commit

Permalink
shorten starting question, add a keypoint
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Nov 2, 2024
1 parent a0a3cce commit 9fd34e7
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions content/dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ Dependency management

- Do you expect your code to work in one year? Five? What if it
uses ``numpy`` or ``tensorflow`` or ``random-github-package`` ?
- How can my collaborators get the same results as me? What about
future me?
- How can my collaborators easily install my codes with all the necessary dependencies?
- How can I make it easy for my colleagues to reproduce my results?
- How can my collaborators easily install my code with all the necessary dependencies?
- How can I make it easy for my others (and me in future) to reproduce my results?
- How can I work on two (or more) projects with different and conflicting dependencies?

.. objectives::
Expand Down Expand Up @@ -763,6 +761,7 @@ Other resources:

.. keypoints::

- If somebody asks you what dependencies your code has, you should be able to answer this question **with a file**.
- Install dependencies by first recording them in ``requirements.txt`` or
``environment.yml`` and install using these files, then you have a trace.
- Use isolated environments and avoid installing packages system-wide.

0 comments on commit 9fd34e7

Please sign in to comment.