diff --git a/.DS_Store b/.DS_Store index 5d6441a..5c8d185 100644 Binary files a/.DS_Store and b/.DS_Store differ diff --git a/.github/workflows/build_docs.yaml b/.github/workflows/build_docs.yaml index 6faa5cf..fa1fe71 100644 --- a/.github/workflows/build_docs.yaml +++ b/.github/workflows/build_docs.yaml @@ -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 @@ -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 \ No newline at end of file + publish_dir: ./docs/_build/html diff --git a/docs/.DS_Store b/docs/.DS_Store index 5f49166..afb898d 100644 Binary files a/docs/.DS_Store and b/docs/.DS_Store differ diff --git a/docs/images/DTOF.png b/docs/images/DTOF.png new file mode 100644 index 0000000..cc9d8ee Binary files /dev/null and b/docs/images/DTOF.png differ diff --git a/docs/images/Flow2.png b/docs/images/Flow2.png new file mode 100644 index 0000000..37d2796 Binary files /dev/null and b/docs/images/Flow2.png differ diff --git a/docs/intro.md b/docs/intro.md index df10d53..e1792fb 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -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