Skip to content

Commit

Permalink
Merge pull request AaltoSciComp#74 from AaltoSciComp/dependencies
Browse files Browse the repository at this point in the history
Dependencies
  • Loading branch information
bast authored Sep 14, 2020
2 parents ce61426 + 6a0b89f commit 8577ed8
Showing 1 changed file with 34 additions and 7 deletions.
41 changes: 34 additions & 7 deletions dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,48 @@ Dependency management

.. questions::

- Q1
- Q2
- How can my collaborators get the same results?
- How can my collaborators easily install my codes with all the necessary dependencies?
- How can make it easy for my colleagues to reproduce my results?

.. objectives::

- O1
- O2
- Record dependencies
- Simplify usage of my codes



(lesson here)
Installing Packages for your project
-------------------------------------

The idea is to start thinking about identifying the list of packages for a given project.

--> Create an environment

- virtualenv
- pipenv
- conda


Dependencies
------------

https://coderefinery.github.io/reproducible-research/03-dependencies/#dependencies

.. challenge:: dependencies 1

Maybe reuse example from preceding episode and ask learners to make the list of dependencies. Does everyone has the exact same version for each package?
Create a requirements.txt for this project.

Could be nice to have an example that requires a version > Y for a package (such ad matplotlib (3D plotting?).


Other Tools for Application Dependency Management
-------------------------------------------------

- poetry
- micropipenv

.. keypoints::

- K1
- K2
- Conda, pip, Virtualenv, Pipenv, pyenv, Poetry, requirements.txt

0 comments on commit 8577ed8

Please sign in to comment.