Notebook-based report
Notebook-based reports are templated Jupyter notebooks that can be computed and published with LSST's nbreport service. Use notebook-based reports for Jupyter notebooks that are continuously rerun against new datasets.
See the nbreport documentation for more information about notebook-based reports.
The document handle adopted by this report.
Typically at LSST handles take the form of XYZ-N.
This is the title of the report. It should succinctly describe the purpose and content of the report.
This is the URL of the GitHub repository that hosts the report.
If the report is not hosted at the root of the Git repository, set the path of the report's base directory relative to the root of the Git repository with this variable. Otherwise, leave as an empty string.
The EXAMPLE-000 directory is a notebook-based report built with the default configurations in cookiecutter.json.
Example: cookiecutter.json.
Add template variables to the mapping in the cookiecutter.json file.
The keys are parameter names and values are defaults.
For example:
{
"param1": "123",
"param2": "abc"
}In the notebook file you can use these template variables as {{cookiecutter.param1}} and {{cookiecutter.param2}}.
The default value of param1 is 123, and the default value of param2 is ABC.
Example: nbreport.yaml.
This file provides configuration metadata for nbreport. You shouldn't need to modify it yourself.
Example: README.md.
This template seeds a README for your report repository. Feel free to expand on it as necessary.
Example: EXAMPLE-000.ipynb.
This is the templated Jupyter notebook that generates the report itself. This template seeds the title cell; it's up to you to add more notebook cells with prose and code.
Keep these guidelines in mind when developing the report template:
- Don't commit the output. Always clear outputs before committing.
- Use Jinja syntax in code and Markdown cells to insert the values of variables.
- Use the nbreport test command to test your notebook template.