Staging module for Akoya - CODEX to MCMICRO
The codex2mc.py script stages CODEX data sets for being registered with ASHLAR in MCMICRO.
The script takes as main input the path to the cycle folder that cointains the raw tiles generated by the Akoya CODEX platform. codex2mc.py reads these tiles and distributes them into acquisition groups. i.e tiles with common rack, well, ROI and exposure levels will be written into an ome.tiff file with the necessary metadata for registration. To be more precise two such ome.tiff files will be generated per cycle, one corresponds to the background signal and the other to the markers signal.
Installation
We recommend installing codex2mc on a clean environment using Python=3.12 and pip. To install codex2mc run the following command:
pip install codex2mc
Usage
Display help message:
codex2mc -h
Display version:
codex2mc -v
CLI
Required arguments
| Argument | Long name | Type | Description | Default value |
|---|---|---|---|---|
| -i | string/path | --input | Absolute path to the the parent folder of the raw tiles, i.e. the cycle folder whose name follows the pattern X_Cycle_N,where N represents the cycle number | NA |
| -o | string/path | --output | Absolute path to the directory in which the outputs will be saved. If the output directory doesn't exist it will be created. | NA |
Optional arguments
| Argument | Type | Long name | Description | Default value |
|---|---|---|---|---|
| -rm | string | --reference_marker | Name of the reference marker for registration | 'DAPI' |
| -od | string | --output_dir | String specifying the name of the subfolder in which the staged images will be saved. | 'raw' |
| -ic | boolean flag | --illumination_correction | Give this flag to apply illumination correction to all tiles, the illumination profiles are calculated with basicpy | FALSE |
| -he | boolean flag | --hi_exposure_only | Give this flag to extract only the set of images with the highest exposure time | FALSE |
Container usage
download container:
- Docker
docker pull ghcr.io/schapirolabor/multiplex_codex:v1.1.0
- Singularity
singularity pull docker://ghcr.io/schapirolabor/multiplex_codex:v1.1.0
Script execution
- Singularity
singularity exec --bind $path_to_your_local_cycle_folder:/mnt,$path_to_your_local_output_folder:/media --no-home $path_to_container python staging/codex2mc/codex2mc.py -i /mnt/$path_to_your_local_cycle_folder -o /media/$path_to_your_local_output_folder
1 maintainer
Metadata
1 maintainer
Release files for codex2mc 0.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| codex2mc-0.0.3.tar.gz | 15.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| codex2mc-0.0.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 33.6 kB
Release files / codex2mc-0.0.3.tar.gz
| Download URL | codex2mc-0.0.3.tar.gz |
|---|---|
| Size | 15.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c17e3d43c64bb3d1c664ba567d633a8dac6c19c4c8740bd809bfc5cb190a3347
|
|
BLAKE2b-256 checksum How to use checksums |
90dc7c1b6db1453210c8e3c675c3e3293411c491788695a8d6a28cbc0d411ab4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.21
|
Release files / codex2mc-0.0.3-py3-none-any.whl
| Download URL | codex2mc-0.0.3-py3-none-any.whl |
|---|---|
| Size | 18.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0fed7529163db62e8d26b1e1ebb1cacb3b6c585250b1b18f27ce6fb684208e25
|
|
BLAKE2b-256 checksum How to use checksums |
ea7fbf3232b95636f28310c7b9f88ca4e0203ae229e6a8e761dd92f89a7e94e0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.21
|
