The Phoenix Chronobiology Projects:
- Work with the University of Minnesota's Halberg Chronobiology Center.
- Operate as a study group of the Twin Cities Section of the Institute of Electrical and Electronics Engineers.
The goals of the Projects are to develop:
- An ambulatory blood pressure monitor that is inexpensive, unobtrusive, easy to use, and collects a week of blood pressure measurements.
- A platform for biorythm analysis.
The Halberg Chronobiology Center wants the monitor and analytic framework for long term use on massive scale for:
- Assessing cardiovascular health, detecting pre-disease early, and optimizing treatment schedules, in order to reduce the number of people who die of preventable heart attacks and strokes.
- Understanding, for health surveillance and maintenance, how blood pressure and heart rate vary in response to stimuli in everyday life.
This repository hosts the Projects' home page, which is published on GitHub Pages.
MkDocs is a static site generator that is geared toward building project documentation. Source files are written primarily in Markdown, and configured with a single YAML configuration file
This site uses Markdown, HTML and cascading style sheets.
For full documentation, visit mkdocs.org.
mkdocs new [dir-name]
- Create a new project.mkdocs serve
- Start the live-reloading docs server.mkdocs build
- Build the documentation site.mkdocs -h
- Print help message and exit.
mkdocs.yml # The configuration file
docs/
index.md # The documentation homepage
about/
index.md
...
abpm/ # ambulatory blood pressure monitor project
index.md
...
biorhythm-platform/ # biorhythm analysis platform project
index.md
architecture/
index.md
...
requirements/
index.md
...
images/
javascripts/
library/
index.md
...
privacy-security/
index.md
...
snippets/
stylesheets/
glossary.md
... # Other markdown pages and other files
The site is built and deployed via GitHub Actions.
The actions are triggered by a git push
to the main
branch.
The repository currently places minimal constraints on change. Anyone with write access may directly
push
content from a local repository to the GitHub repository. Expect more robust change management as the number of contributors grows.
-
Set up
git
-
Checkout repository
git clone https://github.com/phoenix-chronobiology/phoenix-biorhythm-platform.git
-
Set up Node.js runtime
Production environment includes Node version 20.x
-
Set up Node.js dependencies
npm clean-install
-
Set up Python runtime
Production environment includes Python version 3.x
-
Install Python dependencies
pip install mkdocs pip install mkdocs-material pip install mkdocs-macros-plugin pip install mkdocs-git-revision-date-localized-plugin pip install mkdocs-link-marker
-
Build documentation
mkdocs build --clean mkdocs --version
-
Start MkDocs server
See
mkdocs serve -h
for port optionsDefault is port
8000
mkdocs serve
-
Open local site
Use port specified with
mkdocs serve
command