Tip

Update the site by editing files in the docs directory! ✍️

Overview ⚙️

Design docs for the CALIPER components and tools ⚙️

https://ohsu-comp-bio.github.io/caliper-design

Quick Start ⚡

python3 -m venv venv && source venv/bin/activate

pip install -r requirements.txt

# Run locally at http://localhost:8000
mkdocs serve

# Push to GitHub Pages
mkdocs gh-deploy

GitHub Actions 🚀

• ci: Automatic deployment when pushing to the main branch
• pages-build-deployment: Manual deployment from running mkdocs gh-deploy

Additional Resources 📚

• git: Free and open source distributed version control system
• git-lfs: Git Large File Storage — An open source Git extension for versioning large files
• dvc: Data Version Control
• Pandas: Flexible and powerful data analysis / manipulation library

TODO 🌀

• Expand existing docs
• Add automatic link checker
• Add Google Colab examples?