Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build issue #36

Merged
merged 29 commits into from
Nov 1, 2024
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
6762f7a
Cap Python and OMERO.py versions
jburel Oct 18, 2024
3446ff1
Remove link to binderhub
jburel Oct 18, 2024
9e2526d
Remove job adding binder badge
jburel Oct 18, 2024
2796d7a
Update installation instuctions
jburel Oct 18, 2024
744c027
Build environment on GHA
jburel Oct 18, 2024
c000c35
remove repo2docker job
jburel Oct 18, 2024
2bb02a8
Remove macos for now
jburel Oct 18, 2024
730c541
Ignore checkpoint
jburel Oct 18, 2024
1a737cc
review dependencies
jburel Oct 29, 2024
b185eb3
Remove ipykernel installation
jburel Oct 29, 2024
acccff3
Add macos-12 support
jburel Oct 29, 2024
bbb56c0
Fix omero-py version
jburel Oct 29, 2024
d759fd1
Add macos-14
jburel Oct 29, 2024
13ed038
Remove notebook no longer valid
jburel Oct 29, 2024
1bfa903
Review notebook
jburel Oct 29, 2024
956878e
update link to build
jburel Oct 29, 2024
4bd674a
Update rtd instatllation
jburel Oct 29, 2024
7afcd8f
Remove tornado
jburel Oct 30, 2024
af38d6f
Pin Python version
jburel Oct 30, 2024
cec328a
Install older version of tornado to avoid error
jburel Oct 30, 2024
7b9072a
Remove viewing of the results
jburel Oct 30, 2024
7e3c478
Add new ilastik workflow
jburel Oct 30, 2024
6d9b66a
Update link to ilastik model
jburel Oct 30, 2024
1eaaff8
Use matplotlib to display image
jburel Oct 30, 2024
8c1bd9f
Remove itkwidgets and tornado
jburel Oct 30, 2024
fd4ad8f
Remove usage of itkwidgets
jburel Oct 30, 2024
833738f
Display the middle section
jburel Oct 31, 2024
37c2fba
Only use matplotlib to display the image
jburel Nov 1, 2024
0a9b695
Ensure widgets is imported
jburel Nov 1, 2024
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
25 changes: 0 additions & 25 deletions .github/workflows/binder_badge.yml

This file was deleted.

27 changes: 27 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Builds the repository using mamba

---
name: build

on:
push:
pull_request:
schedule:
- cron: '0 0 * * 0'

jobs:
build:
strategy:
matrix:
os: [macos-12, macos-14, ubuntu-latest, windows-latest]
envs: [binder/environment.yml]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.9'
- name: Install Conda environment for ${{ matrix.envs }} with Micromamba
uses: mamba-org/setup-micromamba@v1
with:
environment-file: ${{ matrix.envs }}
23 changes: 0 additions & 23 deletions .github/workflows/repo2docker.yml

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ venv
.DS_Store
*.pyc
_*
*.ipynb_checkpoints
8 changes: 4 additions & 4 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ sphinx:
formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: requirements.txt
build:
os: ubuntu-22.04
tools:
python: "3.11"
61 changes: 47 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,62 @@
# Guide on how to integrate ilastik and OMERO
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ome/omero-guide-ilastik/master?filepath=notebooks)
[![Documentation Status](https://readthedocs.org/projects/omero-guide-ilastik/badge/?version=latest)](https://omero-guides.readthedocs.io/en/latest/ilastik/docs/index.html)
[![Actions Status](https://github.com/ome/omero-guide-ilastik/workflows/repo2docker/badge.svg)](https://github.com/ome/omero-guide-ilastik/actions)
[![Actions Status](https://github.com/ome/omero-guide-ilastik/workflows/build/badge.svg)](https://github.com/ome/omero-guide-ilastik/actions)

The documentation is deployed at [Use Ilastik](https://omero-guides.readthedocs.io/en/latest/ilastik/docs/index.html).

This guide demonstrates how to use ilastik to analyze data stored in [IDR](https://idr.openmicroscopy.org/) or an OMERO server.

This repository contains documentation and notebooks.

To run the notebooks, you can either [run on mybinder.org](https://mybinder.org/v2/gh/ome/omero-guide-ilastik/master?filepath=notebooks) or build locally with [repo2docker](https://repo2docker.readthedocs.io/).
Running locally:

To build locally:
Finally, if you would like to install the necessary requirements locally,
we suggest using Mamba:

* Install [Docker](https://www.docker.com/) if required
* Open a terminal as administrator
* Create a virtual environment and install repo2docker from PyPI.
* Clone this repository
* Run ``repo2docker``
* If you do not have any pre-existing conda installation, [install Mamba](https://mamba.readthedocs.io/en/latest/installation.html#installation) and use [mambaforge](https://github.com/conda-forge/miniforge#mambaforge).
* In case you have a pre-existing conda installation, you can install Mamba by either:
- Using the recommended way to install Mamba from [mambaforge](https://github.com/conda-forge/miniforge#mambaforge). This will not invalidate your conda installation, but possibly your pre-existing conda envs will be in a different location (e.g. ``/Users/USER_NAME/opt/anaconda3/envs/``) then the new mamba envs (e.g. ``/Users/USER_NAME/mambaforge/envs/``). You can verify this by running ``conda env list``. The addition of ``export CONDA_ENVS_PATH=/Users/user/opt/anaconda3/envs/`` into your ``.bashprofile`` or ``.zprofile`` file will fix this.
- Use the [Existing conda install](https://mamba.readthedocs.io/en/latest/installation.html#existing-conda-install) way, i.e. run ``conda install mamba -n base -c conda-forge`` whilst in the base environment. This way can take much longer time than the recommended way described above, and might not lead to a successful installation, especially if run on arm64 (Apple Silicon) OS X.

```
pip install jupyter-repo2docker
git clone https://github.com/ome/omero-guide-ilastik.git
cd omero-guide-ilastik
repo2docker .
Create the environment running the commands below as written:

For Windows, OS X x86_64 (NOT arm64 Apple Silicon), Linux:

$ git clone https://github.com/ome/omero-guide-ilastik

$ cd omero-guide-ilastik

$ mamba env create -f binder/environment.yml

For OS X arm64 Apple Silicon

$ git clone https://github.com/ome/omero-guide-ilastik

$ cd omero-guide-ilastik

$ CONDA_SUBDIR=osx-64 mamba env create -f binder/environment.yml

and activate the newly created environment:

$ conda activate omero-guide-ilastik


Before creating a new environment, remember to deactivate the current one:

$ conda deactivate

See also [Conda command reference](https://docs.conda.io/projects/conda/en/latest/commands.html).

The following steps are only required if you want to run the notebooks.

* If you have Anaconda installed:
* Start Jupyter from the Anaconda-navigator
* To register the environment, run ``python -m ipykernel install --user --name omero-guide-ilastik``
* Select the notebook you wish to run and select the ``Kernel>Change kernel>Python [conda env:omero-guide-ilastik]`` or ``Kernel>Change kernel>omero-guide-ilastik``
* If Anaconda is not installed:
* Open jupyter notebook i.e. ``jupyter notebook`` and select the ``omero-guide-ilastik`` kernel or ``[conda env:omero-guide-ilastik]`` according to what is available.

To stop the notebook server, in the terminal where te server is running, press ``Ctrl C``. The following question will be asked in the terminal ``Shutdown this notebook server (y/[n])?``. Enter the desired choice.
```

This a Sphinx based documentation.
Expand Down
21 changes: 9 additions & 12 deletions binder/environment.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
name: omero-guide-ilastik
channels:
- anaconda
- conda-forge
- ilastik-forge
dependencies:
#- numba==0.48.0
- omero-py
- python==3.9.*
- omero-py==5.19.*
- pip
- ipywidgets
- tornado<6
# ilastik
# see https://github.com/h5py/h5py/issues/1880
- h5py<3.2
- ilastik-dependencies-no-solvers==1.4.3
- ilastik-forge/label/ilastik140::ilastik-meta==1.4.0b14 # ilastik-forge
- ipywidgets==7.8.5
- ilastik-forge::ilastik==1.4.1b22
- ipykernel==6.29.5
- pip:
- yapsy
- itkwidgets
- ome-zarr
- yapsy==1.12.2
- itkwidgets==0.32.6
- ome-zarr==0.9.0
Loading
Loading