```{image} _static/smart-health_logo.webp
:width: 400px
:class: only-light
```

```{image} _static/smart-health-dark_logo.webp
:width: 400px
:class: only-dark
```

___
# Homepage
## Welcome to the Smart Health technical documentation!

```{centered} We gratefully acknowledge the funding recieved from the [BHF Data Science Centre](https://bhfdatasciencecentre.org/areas/smartphones-and-wearables/) to facilitate this project.

This site is hosted on GitHub pages and can be accessed by anyone with access to the source repository.


```{note}
The pipeline development for this project is in progress.

For the initial launch and validation phase, we are focusing on a strictly scoped Minimum-Viable Product (MVP) to process Fitbit data received from Daiser. 

This initial MVP phase runs until the third week of December 2025.
```

### 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.

```{admonition} Click here for more information about each page
:class: dropdown

__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

__Example Smart Health database data__

Examples of the data format in the clean Smart Health database

__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.
```

```{toctree}
   :maxdepth: 1
   :caption: Site Contents:

Project Overview <overview/overview.md>
Glossary of Terms <glossary/glossary.md>
Getting Started <getting_started/getting_started.md>
Raw Data Description <raw_data_desc/raw_data_desc.md>
Data Pipeline <data_pipeline/data_pipeline.md>
Database design <database_design/database_design.md>
Example Notebooks <example_notebooks/example_notebooks.md>
Example Smart Health database data <example_clean_data/example_data.md>
Contributing <contributing/contrib.md>
Acknowledgements <acknowledgements/acknowledgements.md>
```