Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# SCM syntax highlighting & preventing 3-way merges
pixi.lock merge=binary linguist-language=YAML linguist-generated=true
18 changes: 5 additions & 13 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,19 @@ jobs:
docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
fetch-depth: 0

- name: Setup python
uses: actions/setup-python@v5
- uses: astral-sh/setup-uv@v7
with:
python-version: "3.12"

- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools wheel
python -m pip install -e .[docs]
enable-cache: true

- name: Test that docs build without error
if: github.event_name == 'pull_request'
run: mkdocs build --strict
run: uv run mkdocs build --strict

- name: Deploy docs to GitHub Pages
if: github.event_name == 'push'
run: mkdocs gh-deploy --strict --force
run: uv run mkdocs gh-deploy --strict --force


5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# pixi environments
.pixi/*
!.pixi/config.toml

*.egg-info/
7 changes: 3 additions & 4 deletions docs/tutorial/00_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ If you are familiar with python, then I would recommend creating a new environme

## CellPainting Images

[**Download Images for Example Pipeline**](https://github.com/TimMonko/napari-ndev/raw/main/docs/tutorial/cellpainting.zip) Then, extract the files in the ZIP folder.

[**Download Images for Example Pipeline**](https://github.com/ndev-kit/resources/raw/refs/heads/main/image_archives/cellpainting.zip) Then, extract the files in the ZIP folder.
The images come from the [Broad Bioimage Benchmark Collection](https://bbbc.broadinstitute.org/BBBC022/). Investigate the link for the description of the images.

Scale: 0.656um/pixel
Expand All @@ -28,7 +27,7 @@ Channels:

## PrimaryNeuron Images

[**Download Images for Easy Machine Learning Tutorial**](https://github.com/TimMonko/napari-ndev/raw/main/docs/tutorial/primaryneurons.zip)
[**Download Images for Easy Machine Learning Tutorial**](https://github.com/ndev-kit/resources/raw/refs/heads/main/image_archives/primaryneurons.zip)

These images come from my own work at the University of Minnesota in the Thomas Bastian lab. The primary neurons are derived from embryonic mouse brains, and grown for a few days in a dish. The goal is to study morphology and iron homeostasis as the neurons develop over time in conditions of iron deficiency. The images available in the tutorial are extracted from multi-scene CZI files (each original file has over 100 scenes) using the `Image Utilities` widget. Metadata from the CZI files was correct, so the widget automatically passes this downstream without any user input.

Expand All @@ -46,7 +45,7 @@ Channels:

## NeuralProgenitor Images

[**Download Images for Building a Pipeline Tutorial**](https://github.com/TimMonko/napari-ndev/raw/main/docs/tutorial/neuralprogenitors.zip)
[**Download Images for Building a Pipeline Tutorial**](https://github.com/ndev-kit/resources/raw/refs/heads/main/image_archives/neuralprogenitors.zip)

These images come from the Zhe Chen lab at the University of Minnesota. These come from a microscope that *very poorly* saves the images: the images are forced to be saved as RGB (dspite having only one channel in each image) and improper scaling metadata. The images available in this tutorial have already been concatenated and the metadata applied using the `Image Utilities`.

Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
site_name: nDev Documentation
site_url: https://ndev-kit.github.io/docs/
site_url: https://ndev-kit.github.io/
site_description: Documentation for nDev ecosystem tools and packages
repo_name: ndev-kit/docs
repo_url: https://github.com/ndev-kit/docs
repo_name: ndev-kit/ndev-kit.github.io
repo_url: https://github.com/ndev-kit/ndev-kit.github.io
copyright: Copyright © 2023-2025 Tim Monko & nDev Kit Contributors

theme:
Expand Down
Loading