How alleninstitute/openscope_databook works
Project type and purpose
• This is a documentation‐centric static‐site project (“OpenScope Databook”) built with Jupyter Book/Sphinx. Its goal is to host reproducible neuroscience tutorials and analyses using Python notebooks, NWB files, and the DANDI archive. It’s not a conventional client/server web app but a source‐to‐static‐site pipeline with CI/CD and data‐analysis utilities.
File structure
• Top-level:
• docs/ – all the Jupyter notebooks and markdown chapters that form the book.
• databook_utils/ – Python library modules (NWB, DANDI utilities, author/version insertion).
• data/ – sample datasets, schemas, classifiers for offline analysis.
• .github/workflows/ – CI/CD definitions (test, build, deploy, codespell).
• Dockerfile, requirements.txt, runtime.txt, setup.py, apt.txt – environment and packaging.
• Key patterns: source notebooks + helper modules → static‐site build via Jupyter Book → deployment to GitHub Pages. Workflows automate testing of notebooks and code, then build & push the site.
README for additional insights
• The README describes chapters, content goals, external dependencies (NWB, DANDI), and links to the deployed site and DOI. It confirms the pipeline’s inputs (notebooks, configs) and outputs (hosted HTML). There is no runtime backend service beyond static hosting.