hpc-container-maker icon indicating copy to clipboard operation
hpc-container-maker copied to clipboard

Improve documentation on recipe files

Open robertlugg opened this issue 5 years ago • 1 comments

I want to understand the difference between "recipe files" and "module files"

I believe the differences are described here

But there isn't much detail. What is the difference between code written as a recipe and code written as a module? I can guess at a few. But, for instance, does the hpccm tool auto import hpccm before loading the recipe files?

robertlugg avatar Nov 25 '19 17:11 robertlugg

The hpccm CLI tool imports the hpccm module and provides some other boilerplate. See hpccm/cli.py. The CLI tool can save some time and effort in most cases.

However, if you want to customize the behavior or have a "standalone" script that does not require processing by the CLI tool, then you can use the hpccm module in your own Python script. The Jupyter notebook sample does this (recipes/jupyter) in order to add some custom command line options (--notebook, --requirements, etc.).

samcmill avatar Nov 25 '19 17:11 samcmill