This is a skeleton project for creating a reproducible, cross-platform analysis notebook, using Docker. It also includes:
- configuration for
jupytext, to support easier code review - cross-platform startup scripts
- best practice folder structure and documentation
Developers and analysts using this skeleton for new development should
refer to DEVELOPERS.md for instructions on getting
started. Update this README.md so it is a suitable introduction to
your project.
If you have not yet installed Docker, please see the INSTALLATION_GUIDE.md
Notebooks live in the notebooks/ folder (with an ipynb
extension). You can most easily view them on
nbviewer,
though looking at them in Github should also work.
To do development work, you'll need to set up a local jupyter server
and git repository - see DEVELOPERS.md for more detail.
XXX Please change to either a paper (if published) or the repo. You may find it helpful to use Zenodo DOI (see DEVELOPERS.md for further information)