Homepage#
Welcome to the Smart Health technical documentation!#
We gratefully acknowledge the funding recieved from the BHF Data Science Centre to facilitate this project.
Navigating this site#
This site can be navigated using the left-hand side menu, or via the page links under the Site Contents: heading below.
Each page will have an ‘On this page’ menu at the right-hand side.
At the top right-hand-side of the page you can find a link to the source repository for the project codebase.
You can search this site using the search bar at the top left-hand side, or by using the Ctrl+K shortcut.
Within the API reference documentation, each function has a clickable link to switch the view between the source code and documentation.
Click here for more information about each page
Project Overview
An introduction to the Smart Health project, its goals, and the scope of the initial Minimum Viable Product (MVP) phase
Glossary of Terms
A quick reference for common abbreviations, terms, and the tooling used
Getting Started
A quickstart guide to running the Smart Health pipeline
Raw Data Description
Information on the format of the raw data ingressed to the Smart Health pipeline
Data Pipeline
Detailed documentation of the technical specification and implementation of the Smart Health pipeline
Database design
Outlines the design of the clean database generated by the Smart Health pipeline
Example Notebooks
Jupyter Notebooks demonstrating use of the Smart Health Python package
Contributing
A guide for project contributors
Acknowledgements
With thanks to the organisations and individuals that have facilitated this project
API Reference
Detailed technical guide to the Smart Health codebase
Important
The code repository contains example data. Note that this data is synthetic and is not from any real participants.