Skip to content

Commit

Permalink
updated gha workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
ljchang committed Aug 8, 2024
1 parent 28ee6d4 commit 5a5572f
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 8 deletions.
Binary file modified .DS_Store
Binary file not shown.
27 changes: 19 additions & 8 deletions .github/workflows/build_docs.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
# Job (3): Build and deploy docs
name: Build & Deploy Jupyter Book

on:
push:
branches:
- main # Adjust this to your default branch if it's different

jobs:
docs:
name: Build & deploy docs
runs-on: ubuntu-latest

steps:
- name: Checkout Code
uses: actions/checkout@v3
Expand All @@ -13,21 +21,24 @@

- name: Upgrade pip
run: |
# install pip=>20.1 to use "pip cache dir"
python3 -m pip install --upgrade pip
python -m pip install --upgrade pip
- name: Install deps
- name: Install dependencies
run: |
python3 -m pip install . -r requirements.txt
python3 -m pip install -r ./requirements-dev.txt
pip install -r requirements.txt
pip install -r requirements-dev.txt
- name: Build book
run: |
jupyter-book build docs
# echo 'py-feat.org' > ./docs/_build/html/CNAME
- name: Debug - List files
run: |
ls -la
ls -la docs/_build/html
- name: Deploy docs
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
publish_dir: ./docs/_build/html
Binary file modified docs/.DS_Store
Binary file not shown.
Binary file added docs/images/DTOF.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Flow2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ TD fNIRS uses time gating to discriminate the photons arriving to the detector a

A common way to summarize information from time-of-flight histograms is to compute the first three moments of the histogram corresponding to the total counts (sum), mean time-of-flight (first moment), and variance of the times of flight (second central moment). Moments have a convenient property: the moments of the DTOF can be obtained from calculating the moments of the TPSF and of the IRF straightforwardly. Accordingly, with Flow2, system drift in the DTOF moments can be corrected for, using the internal IRF detector. However, the instrument response function (IRF) can complicate data interpretation in TD-fNIRS. To address this, moment analysis of the distribution of times of flight (DTOF) has been proposed as an alternative to time gates analysis. Higher statistical moments of the DTOF show increased sensitivity to deeper tissue layers.

{image} images/flow2.png


## Flow 2

{image} images/DTOF.png

## Resources

Expand Down

0 comments on commit 5a5572f

Please sign in to comment.