https://github.com/scikit-image/euroscipy24-tutorial
scikit-image tutorial at EuroSciPy 2024
https://github.com/scikit-image/euroscipy24-tutorial
Last synced: 3 months ago
JSON representation
scikit-image tutorial at EuroSciPy 2024
- Host: GitHub
- URL: https://github.com/scikit-image/euroscipy24-tutorial
- Owner: scikit-image
- License: bsd-3-clause
- Created: 2024-08-19T16:37:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-22T17:15:04.000Z (about 1 year ago)
- Last Synced: 2025-04-22T11:14:37.413Z (9 months ago)
- Language: Python
- Homepage: https://scikit-image.org/euroscipy24-tutorial/lab/index.html?path=00_start.ipynb
- Size: 4.52 MB
- Stars: 1
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# scikit-image tutorial at EuroSciPy 2024
This repository contains the teaching materials for the [scikit-image tutorial at EuroSciPy 2024](https://pretalx.com/euroscipy-2024/talk/ZVBAKK/).
> [!IMPORTANT]
> The tutorial is intended to be run in the browser. \
> **[Open the online tutorial here](https://scikit-image.org/euroscipy24-tutorial/lab/index.html?path=00_start.ipynb)**!
## Contributing
### Run notebooks in local environment
Updating the notebooks is best accomplished inside a local environment.
Create a new virtual environment with Python 3.12 and install the dependencies into it with
```shell
python -m pip install -r requirements/local_dev.txt
```
If you want to add a dependency to `local_dev.txt`, add it to the corresponding `local_dev.in` instead and run
```shell
uv pip compile -o requirements/local_dev.txt requirements/local_dev.in
```
### Build & serve website locally
Setup the required dependencies with
```shell
python -m pip install -r requirements/jupyterlite.txt
```
This repository stores the notebooks in markdown format with the help of [Jupytext](https://jupytext.readthedocs.io/en/latest/) which is not yet supported by JupyterLite.
So we need to convert the notebooks into the `ipynb` format with
```shell
find tutorial/ -name "*.md" -exec jupytext --to ipynb {} \;
```
then build & serve the site:
```shell
jupyter lite build --contents tutorial/
jupyter lite serve
```
If you want to add a dependency to `jupyterlite.txt`, add it to the corresponding `jupyterlite.in` instead and run
```shell
uv pip compile -o requirements/jupyterlite.txt requirements/jupyterlite.in
```
## Acknowledgements
Builds on the original [scikit-image tutorials](https://github.com/scikit-image/skimage-tutorials), last years tutorial at [EuroSciPy 2023](https://github.com/glemaitre/euroscipy-2023-scikit-image) by Guillaume Lemaitre, and the [joined image analysis tutorial at SciPy 2024](https://github.com/scipy-2024-image-analysis/tutorial).