Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation on recipe files #199

Open
robertlugg opened this issue Nov 25, 2019 · 1 comment
Open

Improve documentation on recipe files #199

robertlugg opened this issue Nov 25, 2019 · 1 comment

Comments

@robertlugg
Copy link

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?

@samcmill
Copy link
Collaborator

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.).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants