bcf-scape 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- bcf_scape-0.1.0/LICENSE +29 -0
- bcf_scape-0.1.0/PKG-INFO +136 -0
- bcf_scape-0.1.0/README.md +93 -0
- bcf_scape-0.1.0/bcf_scape.egg-info/PKG-INFO +136 -0
- bcf_scape-0.1.0/bcf_scape.egg-info/SOURCES.txt +28 -0
- bcf_scape-0.1.0/bcf_scape.egg-info/dependency_links.txt +1 -0
- bcf_scape-0.1.0/bcf_scape.egg-info/entry_points.txt +2 -0
- bcf_scape-0.1.0/bcf_scape.egg-info/requires.txt +17 -0
- bcf_scape-0.1.0/bcf_scape.egg-info/top_level.txt +1 -0
- bcf_scape-0.1.0/pyproject.toml +72 -0
- bcf_scape-0.1.0/scape/__init__.py +37 -0
- bcf_scape-0.1.0/scape/__main__.py +4 -0
- bcf_scape-0.1.0/scape/batch/__init__.py +3 -0
- bcf_scape-0.1.0/scape/batch/processor.py +135 -0
- bcf_scape-0.1.0/scape/cli.py +485 -0
- bcf_scape-0.1.0/scape/config/__init__.py +3 -0
- bcf_scape-0.1.0/scape/config/settings.py +420 -0
- bcf_scape-0.1.0/scape/config/wizard.py +366 -0
- bcf_scape-0.1.0/scape/metadata/__init__.py +3 -0
- bcf_scape-0.1.0/scape/metadata/parser.py +183 -0
- bcf_scape-0.1.0/scape/output/__init__.py +3 -0
- bcf_scape-0.1.0/scape/output/saver.py +115 -0
- bcf_scape-0.1.0/scape/pipeline.py +356 -0
- bcf_scape-0.1.0/scape/preprocessing/__init__.py +3 -0
- bcf_scape-0.1.0/scape/preprocessing/image_handler.py +121 -0
- bcf_scape-0.1.0/scape/processing/__init__.py +3 -0
- bcf_scape-0.1.0/scape/processing/deskew_engine.py +115 -0
- bcf_scape-0.1.0/scape/visualization/__init__.py +3 -0
- bcf_scape-0.1.0/scape/visualization/viewer.py +77 -0
- bcf_scape-0.1.0/setup.cfg +4 -0
bcf_scape-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
BSD 3-Clause License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026, Max Planck Institute of Molecular Cell Biology and Genetics (MPI-CBG)
|
|
4
|
+
All rights reserved.
|
|
5
|
+
|
|
6
|
+
Redistribution and use in source and binary forms, with or without
|
|
7
|
+
modification, are permitted provided that the following conditions are met:
|
|
8
|
+
|
|
9
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
|
10
|
+
list of conditions and the following disclaimer.
|
|
11
|
+
|
|
12
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
13
|
+
this list of conditions and the following disclaimer in the documentation
|
|
14
|
+
and/or other materials provided with the distribution.
|
|
15
|
+
|
|
16
|
+
3. Neither the name of the copyright holder nor the names of its
|
|
17
|
+
contributors may be used to endorse or promote products derived from
|
|
18
|
+
this software without specific prior written permission.
|
|
19
|
+
|
|
20
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
21
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
22
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
23
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
24
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
25
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
26
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
27
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
28
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
29
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
bcf_scape-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: bcf-scape
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: SCAPE light-sheet microscopy data processing (deskewing, max-projection, batch I/O).
|
|
5
|
+
Author: Tomas Skripcak
|
|
6
|
+
Author-email: HongKee Moon <moon@mpi-cbg.de>
|
|
7
|
+
Maintainer-email: "Scientific Computing Facility, MPI-CBG" <scicomp@mpi-cbg.de>
|
|
8
|
+
License-Expression: BSD-3-Clause
|
|
9
|
+
Project-URL: Homepage, https://git.mpi-cbg.de/scicomp/scidev_team/bcf_scape
|
|
10
|
+
Project-URL: Source, https://git.mpi-cbg.de/scicomp/scidev_team/bcf_scape
|
|
11
|
+
Project-URL: Issues, https://git.mpi-cbg.de/scicomp/scidev_team/bcf_scape/-/issues
|
|
12
|
+
Keywords: scape,light-sheet,microscopy,deskew,ome-tiff,pyclesperanto
|
|
13
|
+
Classifier: Development Status :: 4 - Beta
|
|
14
|
+
Classifier: Intended Audience :: Science/Research
|
|
15
|
+
Classifier: Topic :: Scientific/Engineering :: Image Processing
|
|
16
|
+
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
|
|
17
|
+
Classifier: Programming Language :: Python :: 3
|
|
18
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
24
|
+
Classifier: Operating System :: OS Independent
|
|
25
|
+
Requires-Python: >=3.8
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
License-File: LICENSE
|
|
28
|
+
Requires-Dist: numpy
|
|
29
|
+
Requires-Dist: tifffile
|
|
30
|
+
Requires-Dist: pyclesperanto
|
|
31
|
+
Requires-Dist: pyclesperanto-prototype
|
|
32
|
+
Requires-Dist: tomli_w
|
|
33
|
+
Requires-Dist: tomli; python_version < "3.11"
|
|
34
|
+
Requires-Dist: tqdm
|
|
35
|
+
Requires-Dist: matplotlib
|
|
36
|
+
Requires-Dist: ipywidgets
|
|
37
|
+
Requires-Dist: Pillow
|
|
38
|
+
Provides-Extra: dev
|
|
39
|
+
Requires-Dist: pytest; extra == "dev"
|
|
40
|
+
Requires-Dist: build; extra == "dev"
|
|
41
|
+
Requires-Dist: twine; extra == "dev"
|
|
42
|
+
Dynamic: license-file
|
|
43
|
+
|
|
44
|
+
# bcf-scape
|
|
45
|
+
|
|
46
|
+
`bcf-scape` is a modular Python library for processing **SCAPE light-sheet
|
|
47
|
+
microscopy** data: deskewing OME-TIFF stacks, computing Z / Y max-projections,
|
|
48
|
+
and batch-processing multi-position / multi-timepoint acquisitions.
|
|
49
|
+
|
|
50
|
+
GPU-accelerated via [`pyclesperanto`](https://github.com/clEsperanto/pyclesperanto).
|
|
51
|
+
|
|
52
|
+
Developed and maintained by the Scientific Computing Facility at MPI-CBG.
|
|
53
|
+
|
|
54
|
+
## Installation
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
pip install bcf-scape
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
The package imports as `scape`:
|
|
61
|
+
|
|
62
|
+
```python
|
|
63
|
+
import scape
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Quick start
|
|
67
|
+
|
|
68
|
+
### Command line
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
python -m scape.pipeline \
|
|
72
|
+
--settings settings.toml \
|
|
73
|
+
--tiff /data/raw/scan.ome.tif \
|
|
74
|
+
--output /data/processed/Deskewed/
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
or via the console script:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
scape --help
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Python API
|
|
84
|
+
|
|
85
|
+
```python
|
|
86
|
+
from scape.config.settings import load_settings_from_file
|
|
87
|
+
from scape.pipeline import run
|
|
88
|
+
|
|
89
|
+
settings = load_settings_from_file("settings.toml")
|
|
90
|
+
run(settings, "/data/raw/scan.ome.tif", "/data/processed/Deskewed/")
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## TOML configuration
|
|
94
|
+
|
|
95
|
+
`ProcessingSettings` round-trips to a human-readable TOML file:
|
|
96
|
+
|
|
97
|
+
```python
|
|
98
|
+
from scape.config.settings import ProcessingSettings
|
|
99
|
+
|
|
100
|
+
settings = ProcessingSettings()
|
|
101
|
+
settings.lightsheet_angle_in_degrees = 39
|
|
102
|
+
settings.save_toml("my_run.toml")
|
|
103
|
+
|
|
104
|
+
# Later …
|
|
105
|
+
settings = ProcessingSettings.load_toml("my_run.toml")
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Modules
|
|
109
|
+
|
|
110
|
+
| Module | Responsibility |
|
|
111
|
+
| --- | --- |
|
|
112
|
+
| `scape.pipeline` | End-to-end deskewing pipeline (CLI entry point) |
|
|
113
|
+
| `scape.config.settings` | `ProcessingSettings` + TOML I/O |
|
|
114
|
+
| `scape.metadata.parser` | OME-TIFF metadata extraction |
|
|
115
|
+
| `scape.preprocessing.image_handler` | Channel/timepoint selection, dual-camera flips |
|
|
116
|
+
| `scape.processing.deskew_engine` | Deskewing primitives |
|
|
117
|
+
| `scape.batch.processor` | Multi-position / multi-timepoint orchestration |
|
|
118
|
+
| `scape.output.saver` | TIFF writing helpers |
|
|
119
|
+
| `scape.visualization.viewer` | Interactive Jupyter previews |
|
|
120
|
+
|
|
121
|
+
## Citation
|
|
122
|
+
|
|
123
|
+
If this package contributes to a publication, please acknowledge the
|
|
124
|
+
Scientific Computing Facility at MPI-CBG. Contact `scicomp@mpi-cbg.de`
|
|
125
|
+
for the formal citation entry.
|
|
126
|
+
|
|
127
|
+
## Links
|
|
128
|
+
|
|
129
|
+
* Source: <https://git.mpi-cbg.de/scicomp/scidev_team/bcf_scape>
|
|
130
|
+
|
|
131
|
+
## License
|
|
132
|
+
|
|
133
|
+
BSD-3-Clause. See [LICENSE](LICENSE).
|
|
134
|
+
|
|
135
|
+
Copyright © 2026 Max Planck Institute of Molecular Cell Biology and Genetics
|
|
136
|
+
(MPI-CBG).
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# bcf-scape
|
|
2
|
+
|
|
3
|
+
`bcf-scape` is a modular Python library for processing **SCAPE light-sheet
|
|
4
|
+
microscopy** data: deskewing OME-TIFF stacks, computing Z / Y max-projections,
|
|
5
|
+
and batch-processing multi-position / multi-timepoint acquisitions.
|
|
6
|
+
|
|
7
|
+
GPU-accelerated via [`pyclesperanto`](https://github.com/clEsperanto/pyclesperanto).
|
|
8
|
+
|
|
9
|
+
Developed and maintained by the Scientific Computing Facility at MPI-CBG.
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pip install bcf-scape
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
The package imports as `scape`:
|
|
18
|
+
|
|
19
|
+
```python
|
|
20
|
+
import scape
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Quick start
|
|
24
|
+
|
|
25
|
+
### Command line
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
python -m scape.pipeline \
|
|
29
|
+
--settings settings.toml \
|
|
30
|
+
--tiff /data/raw/scan.ome.tif \
|
|
31
|
+
--output /data/processed/Deskewed/
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
or via the console script:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
scape --help
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Python API
|
|
41
|
+
|
|
42
|
+
```python
|
|
43
|
+
from scape.config.settings import load_settings_from_file
|
|
44
|
+
from scape.pipeline import run
|
|
45
|
+
|
|
46
|
+
settings = load_settings_from_file("settings.toml")
|
|
47
|
+
run(settings, "/data/raw/scan.ome.tif", "/data/processed/Deskewed/")
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## TOML configuration
|
|
51
|
+
|
|
52
|
+
`ProcessingSettings` round-trips to a human-readable TOML file:
|
|
53
|
+
|
|
54
|
+
```python
|
|
55
|
+
from scape.config.settings import ProcessingSettings
|
|
56
|
+
|
|
57
|
+
settings = ProcessingSettings()
|
|
58
|
+
settings.lightsheet_angle_in_degrees = 39
|
|
59
|
+
settings.save_toml("my_run.toml")
|
|
60
|
+
|
|
61
|
+
# Later …
|
|
62
|
+
settings = ProcessingSettings.load_toml("my_run.toml")
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Modules
|
|
66
|
+
|
|
67
|
+
| Module | Responsibility |
|
|
68
|
+
| --- | --- |
|
|
69
|
+
| `scape.pipeline` | End-to-end deskewing pipeline (CLI entry point) |
|
|
70
|
+
| `scape.config.settings` | `ProcessingSettings` + TOML I/O |
|
|
71
|
+
| `scape.metadata.parser` | OME-TIFF metadata extraction |
|
|
72
|
+
| `scape.preprocessing.image_handler` | Channel/timepoint selection, dual-camera flips |
|
|
73
|
+
| `scape.processing.deskew_engine` | Deskewing primitives |
|
|
74
|
+
| `scape.batch.processor` | Multi-position / multi-timepoint orchestration |
|
|
75
|
+
| `scape.output.saver` | TIFF writing helpers |
|
|
76
|
+
| `scape.visualization.viewer` | Interactive Jupyter previews |
|
|
77
|
+
|
|
78
|
+
## Citation
|
|
79
|
+
|
|
80
|
+
If this package contributes to a publication, please acknowledge the
|
|
81
|
+
Scientific Computing Facility at MPI-CBG. Contact `scicomp@mpi-cbg.de`
|
|
82
|
+
for the formal citation entry.
|
|
83
|
+
|
|
84
|
+
## Links
|
|
85
|
+
|
|
86
|
+
* Source: <https://git.mpi-cbg.de/scicomp/scidev_team/bcf_scape>
|
|
87
|
+
|
|
88
|
+
## License
|
|
89
|
+
|
|
90
|
+
BSD-3-Clause. See [LICENSE](LICENSE).
|
|
91
|
+
|
|
92
|
+
Copyright © 2026 Max Planck Institute of Molecular Cell Biology and Genetics
|
|
93
|
+
(MPI-CBG).
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: bcf-scape
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: SCAPE light-sheet microscopy data processing (deskewing, max-projection, batch I/O).
|
|
5
|
+
Author: Tomas Skripcak
|
|
6
|
+
Author-email: HongKee Moon <moon@mpi-cbg.de>
|
|
7
|
+
Maintainer-email: "Scientific Computing Facility, MPI-CBG" <scicomp@mpi-cbg.de>
|
|
8
|
+
License-Expression: BSD-3-Clause
|
|
9
|
+
Project-URL: Homepage, https://git.mpi-cbg.de/scicomp/scidev_team/bcf_scape
|
|
10
|
+
Project-URL: Source, https://git.mpi-cbg.de/scicomp/scidev_team/bcf_scape
|
|
11
|
+
Project-URL: Issues, https://git.mpi-cbg.de/scicomp/scidev_team/bcf_scape/-/issues
|
|
12
|
+
Keywords: scape,light-sheet,microscopy,deskew,ome-tiff,pyclesperanto
|
|
13
|
+
Classifier: Development Status :: 4 - Beta
|
|
14
|
+
Classifier: Intended Audience :: Science/Research
|
|
15
|
+
Classifier: Topic :: Scientific/Engineering :: Image Processing
|
|
16
|
+
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
|
|
17
|
+
Classifier: Programming Language :: Python :: 3
|
|
18
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
24
|
+
Classifier: Operating System :: OS Independent
|
|
25
|
+
Requires-Python: >=3.8
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
License-File: LICENSE
|
|
28
|
+
Requires-Dist: numpy
|
|
29
|
+
Requires-Dist: tifffile
|
|
30
|
+
Requires-Dist: pyclesperanto
|
|
31
|
+
Requires-Dist: pyclesperanto-prototype
|
|
32
|
+
Requires-Dist: tomli_w
|
|
33
|
+
Requires-Dist: tomli; python_version < "3.11"
|
|
34
|
+
Requires-Dist: tqdm
|
|
35
|
+
Requires-Dist: matplotlib
|
|
36
|
+
Requires-Dist: ipywidgets
|
|
37
|
+
Requires-Dist: Pillow
|
|
38
|
+
Provides-Extra: dev
|
|
39
|
+
Requires-Dist: pytest; extra == "dev"
|
|
40
|
+
Requires-Dist: build; extra == "dev"
|
|
41
|
+
Requires-Dist: twine; extra == "dev"
|
|
42
|
+
Dynamic: license-file
|
|
43
|
+
|
|
44
|
+
# bcf-scape
|
|
45
|
+
|
|
46
|
+
`bcf-scape` is a modular Python library for processing **SCAPE light-sheet
|
|
47
|
+
microscopy** data: deskewing OME-TIFF stacks, computing Z / Y max-projections,
|
|
48
|
+
and batch-processing multi-position / multi-timepoint acquisitions.
|
|
49
|
+
|
|
50
|
+
GPU-accelerated via [`pyclesperanto`](https://github.com/clEsperanto/pyclesperanto).
|
|
51
|
+
|
|
52
|
+
Developed and maintained by the Scientific Computing Facility at MPI-CBG.
|
|
53
|
+
|
|
54
|
+
## Installation
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
pip install bcf-scape
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
The package imports as `scape`:
|
|
61
|
+
|
|
62
|
+
```python
|
|
63
|
+
import scape
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Quick start
|
|
67
|
+
|
|
68
|
+
### Command line
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
python -m scape.pipeline \
|
|
72
|
+
--settings settings.toml \
|
|
73
|
+
--tiff /data/raw/scan.ome.tif \
|
|
74
|
+
--output /data/processed/Deskewed/
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
or via the console script:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
scape --help
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Python API
|
|
84
|
+
|
|
85
|
+
```python
|
|
86
|
+
from scape.config.settings import load_settings_from_file
|
|
87
|
+
from scape.pipeline import run
|
|
88
|
+
|
|
89
|
+
settings = load_settings_from_file("settings.toml")
|
|
90
|
+
run(settings, "/data/raw/scan.ome.tif", "/data/processed/Deskewed/")
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## TOML configuration
|
|
94
|
+
|
|
95
|
+
`ProcessingSettings` round-trips to a human-readable TOML file:
|
|
96
|
+
|
|
97
|
+
```python
|
|
98
|
+
from scape.config.settings import ProcessingSettings
|
|
99
|
+
|
|
100
|
+
settings = ProcessingSettings()
|
|
101
|
+
settings.lightsheet_angle_in_degrees = 39
|
|
102
|
+
settings.save_toml("my_run.toml")
|
|
103
|
+
|
|
104
|
+
# Later …
|
|
105
|
+
settings = ProcessingSettings.load_toml("my_run.toml")
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Modules
|
|
109
|
+
|
|
110
|
+
| Module | Responsibility |
|
|
111
|
+
| --- | --- |
|
|
112
|
+
| `scape.pipeline` | End-to-end deskewing pipeline (CLI entry point) |
|
|
113
|
+
| `scape.config.settings` | `ProcessingSettings` + TOML I/O |
|
|
114
|
+
| `scape.metadata.parser` | OME-TIFF metadata extraction |
|
|
115
|
+
| `scape.preprocessing.image_handler` | Channel/timepoint selection, dual-camera flips |
|
|
116
|
+
| `scape.processing.deskew_engine` | Deskewing primitives |
|
|
117
|
+
| `scape.batch.processor` | Multi-position / multi-timepoint orchestration |
|
|
118
|
+
| `scape.output.saver` | TIFF writing helpers |
|
|
119
|
+
| `scape.visualization.viewer` | Interactive Jupyter previews |
|
|
120
|
+
|
|
121
|
+
## Citation
|
|
122
|
+
|
|
123
|
+
If this package contributes to a publication, please acknowledge the
|
|
124
|
+
Scientific Computing Facility at MPI-CBG. Contact `scicomp@mpi-cbg.de`
|
|
125
|
+
for the formal citation entry.
|
|
126
|
+
|
|
127
|
+
## Links
|
|
128
|
+
|
|
129
|
+
* Source: <https://git.mpi-cbg.de/scicomp/scidev_team/bcf_scape>
|
|
130
|
+
|
|
131
|
+
## License
|
|
132
|
+
|
|
133
|
+
BSD-3-Clause. See [LICENSE](LICENSE).
|
|
134
|
+
|
|
135
|
+
Copyright © 2026 Max Planck Institute of Molecular Cell Biology and Genetics
|
|
136
|
+
(MPI-CBG).
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
README.md
|
|
3
|
+
pyproject.toml
|
|
4
|
+
bcf_scape.egg-info/PKG-INFO
|
|
5
|
+
bcf_scape.egg-info/SOURCES.txt
|
|
6
|
+
bcf_scape.egg-info/dependency_links.txt
|
|
7
|
+
bcf_scape.egg-info/entry_points.txt
|
|
8
|
+
bcf_scape.egg-info/requires.txt
|
|
9
|
+
bcf_scape.egg-info/top_level.txt
|
|
10
|
+
scape/__init__.py
|
|
11
|
+
scape/__main__.py
|
|
12
|
+
scape/cli.py
|
|
13
|
+
scape/pipeline.py
|
|
14
|
+
scape/batch/__init__.py
|
|
15
|
+
scape/batch/processor.py
|
|
16
|
+
scape/config/__init__.py
|
|
17
|
+
scape/config/settings.py
|
|
18
|
+
scape/config/wizard.py
|
|
19
|
+
scape/metadata/__init__.py
|
|
20
|
+
scape/metadata/parser.py
|
|
21
|
+
scape/output/__init__.py
|
|
22
|
+
scape/output/saver.py
|
|
23
|
+
scape/preprocessing/__init__.py
|
|
24
|
+
scape/preprocessing/image_handler.py
|
|
25
|
+
scape/processing/__init__.py
|
|
26
|
+
scape/processing/deskew_engine.py
|
|
27
|
+
scape/visualization/__init__.py
|
|
28
|
+
scape/visualization/viewer.py
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
scape
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "bcf-scape"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "SCAPE light-sheet microscopy data processing (deskewing, max-projection, batch I/O)."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "BSD-3-Clause"
|
|
11
|
+
license-files = ["LICENSE"]
|
|
12
|
+
requires-python = ">=3.8"
|
|
13
|
+
authors = [
|
|
14
|
+
{ name = "HongKee Moon", email = "moon@mpi-cbg.de" },
|
|
15
|
+
{ name = "Tomas Skripcak" },
|
|
16
|
+
]
|
|
17
|
+
maintainers = [
|
|
18
|
+
{ name = "Scientific Computing Facility, MPI-CBG", email = "scicomp@mpi-cbg.de" },
|
|
19
|
+
]
|
|
20
|
+
keywords = [
|
|
21
|
+
"scape",
|
|
22
|
+
"light-sheet",
|
|
23
|
+
"microscopy",
|
|
24
|
+
"deskew",
|
|
25
|
+
"ome-tiff",
|
|
26
|
+
"pyclesperanto",
|
|
27
|
+
]
|
|
28
|
+
classifiers = [
|
|
29
|
+
"Development Status :: 4 - Beta",
|
|
30
|
+
"Intended Audience :: Science/Research",
|
|
31
|
+
"Topic :: Scientific/Engineering :: Image Processing",
|
|
32
|
+
"Topic :: Scientific/Engineering :: Bio-Informatics",
|
|
33
|
+
"Programming Language :: Python :: 3",
|
|
34
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
35
|
+
"Programming Language :: Python :: 3.8",
|
|
36
|
+
"Programming Language :: Python :: 3.9",
|
|
37
|
+
"Programming Language :: Python :: 3.10",
|
|
38
|
+
"Programming Language :: Python :: 3.11",
|
|
39
|
+
"Programming Language :: Python :: 3.12",
|
|
40
|
+
"Operating System :: OS Independent",
|
|
41
|
+
]
|
|
42
|
+
dependencies = [
|
|
43
|
+
"numpy",
|
|
44
|
+
"tifffile",
|
|
45
|
+
"pyclesperanto",
|
|
46
|
+
"pyclesperanto-prototype",
|
|
47
|
+
"tomli_w",
|
|
48
|
+
"tomli; python_version < '3.11'",
|
|
49
|
+
"tqdm",
|
|
50
|
+
"matplotlib",
|
|
51
|
+
"ipywidgets",
|
|
52
|
+
"Pillow",
|
|
53
|
+
]
|
|
54
|
+
|
|
55
|
+
[project.optional-dependencies]
|
|
56
|
+
dev = [
|
|
57
|
+
"pytest",
|
|
58
|
+
"build",
|
|
59
|
+
"twine",
|
|
60
|
+
]
|
|
61
|
+
|
|
62
|
+
[project.urls]
|
|
63
|
+
Homepage = "https://git.mpi-cbg.de/scicomp/scidev_team/bcf_scape"
|
|
64
|
+
Source = "https://git.mpi-cbg.de/scicomp/scidev_team/bcf_scape"
|
|
65
|
+
Issues = "https://git.mpi-cbg.de/scicomp/scidev_team/bcf_scape/-/issues"
|
|
66
|
+
|
|
67
|
+
[project.scripts]
|
|
68
|
+
scape = "scape.cli:main"
|
|
69
|
+
|
|
70
|
+
[tool.setuptools.packages.find]
|
|
71
|
+
include = ["scape*"]
|
|
72
|
+
exclude = ["tests*"]
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"""
|
|
2
|
+
SCAPE - Light Sheet Microscopy Image Processing Pipeline
|
|
3
|
+
========================================================
|
|
4
|
+
|
|
5
|
+
A modular Python library for processing light sheet microscopy data
|
|
6
|
+
(deskewing, max-projection, batch processing of OME-TIFF stacks).
|
|
7
|
+
|
|
8
|
+
Quick start
|
|
9
|
+
-----------
|
|
10
|
+
|
|
11
|
+
Run the pipeline from the command line::
|
|
12
|
+
|
|
13
|
+
python -m scape.pipeline \\
|
|
14
|
+
--settings settings.toml \\
|
|
15
|
+
--tiff /data/raw/scan.ome.tif \\
|
|
16
|
+
--output /data/processed/Deskewed/
|
|
17
|
+
|
|
18
|
+
Or use the Python API::
|
|
19
|
+
|
|
20
|
+
from scape.config.settings import load_settings_from_file
|
|
21
|
+
from scape.pipeline import run
|
|
22
|
+
|
|
23
|
+
settings = load_settings_from_file("settings.toml")
|
|
24
|
+
run(settings, "/data/raw/scan.ome.tif", "/data/processed/Deskewed/")
|
|
25
|
+
|
|
26
|
+
Main modules
|
|
27
|
+
------------
|
|
28
|
+
|
|
29
|
+
* :mod:`scape.pipeline` – end-to-end processing entry point
|
|
30
|
+
* :mod:`scape.config.settings` – ``ProcessingSettings`` and TOML I/O
|
|
31
|
+
* :mod:`scape.metadata.parser` – OME-TIFF metadata extraction
|
|
32
|
+
* :mod:`scape.preprocessing.image_handler` – channel/timepoint selection, flips
|
|
33
|
+
* :mod:`scape.processing.deskew_engine` – deskewing primitives
|
|
34
|
+
* :mod:`scape.batch.processor` – multi-position / multi-timepoint loops
|
|
35
|
+
* :mod:`scape.output.saver` – TIFF writing helpers
|
|
36
|
+
* :mod:`scape.visualization.viewer` – interactive Jupyter previews
|
|
37
|
+
"""
|