The notebook-infrastructure repository provides standards and software infrastructure to support Jupyter notebooks intended for public consumption at the Space Telescope Science Institute (STScI). It includes documentation, templates, and tools to assist with the creation, management, and deployment of high-quality, reviewable notebooks.
- docs/ – Documentation for CI, contributor workflows, and usage.
- notebook-repo-template/ – A GitHub repository template to create notebook projects that conform to STScI guidelines.
- tools/ – Additional utilities for managing notebook repositories outside the template.
- README.md – This file.
Detailed instructions and documentation are available at:
📘 notebook-infrastructure.readthedocs.io
This includes:
- CI system overview
- Action descriptions
- Workflow examples
- Contributor and operator guides
- Repository creation instructions
To create a new repository using this infrastructure:
- Visit the Creating a Repo guide.
- Use the
notebook-repo-templateto initialize your notebook project. - Follow the CI setup and customization instructions.
- Trigger test runs with a sample change (e.g., edit
example.ipynb) via a pull request.
We welcome contributions that improve this infrastructure! To contribute:
- Fork the repository
- Create a feature branch off
main - Make your changes, ensuring consistency with existing styles and standards
- Open a pull request with a clear description
Refer to the Contributing Guide for more detailed guidance.
This project is licensed under the BSD 3-Clause License.
See the LICENSE file for more details.
Maintained by: Space Telescope Science Institute (STScI)