SCALLOPS

SCALLOPS (Scalable Library for Optical Pooled Screens) is a comprehensive Python package designed to streamline and scale the analysis of Optical Pooled Screens (OPS) for biological data. With a focus on handling large-scale, high-throughput screening data, SCALLOPS provides tools for efficiently processing, analyzing, and interpreting OPS data, leveraging modern distributed computing frameworks like Dask.

Documentation

The full documentation, API reference, and tutorials can be found at: http://scallops.readthedocs.io

Repository Structure

scallops/
├── .github/             # CI/CD workflows
├── docs/                # Documentation source (Sphinx)
├── scallops/            # Main Python package source
│   ├── cli/             # CLI entry points
│   ├── core/            # Core processing logic
│   └── utils/           # Utilities
├── wdl/                 # WDL pipeline definitions
├── Dockerfile           # Docker image definition
├── pyproject.toml       # Build metadata
├── requirements.txt     # Main dependencies
├── setup.py             # Installation script
└── README.md            # Project overview

Getting Started

Prerequisites

SCALLOPS requires Python 3.11 or newer (3.12 is the default in the Docker image).

1. Environment Setup (Recommended)

We recommend using uv for high-performance Python environment management. You will need uv installed on your system. Installation instructions can be found here: https://docs.astral.sh/uv/

To set up a virtual environment:

# Create a virtual environment with a specific Python version
uv venv --python 3.12

# Activate the environment
# On macOS/Linux:
source .venv/bin/activate
# On Windows:
.venv\Scripts\activate

2. Installation and Usage Options

Option 1: Install from PyPI (Standard)

The easiest way to install the stable version is via pip (or uv pip):

uv pip install scallops

Option 2: Run via Docker (GitHub Container Registry)

SCALLOPS is available as a containerized image via the GitHub Container Registry (GHCR). This is the best option for ensuring environment consistency.

# Pull the latest image
docker pull ghcr.io/genentech/scallops:latest

# Run the CLI directly
docker run --rm ghcr.io/genentech/scallops:latest scallops --help

Option 3: Install from Source (Development)

If you wish to contribute to the codebase or need the latest unreleased changes:

Clone the repository:

git clone [https://github.com/Genentech/scallops.git](https://github.com/Genentech/scallops.git)
cd scallops

Install in editable mode:

uv pip install -r requirements.txt -e .

Main Focus Areas

High-Throughput Data Processing: Designed to manage massive datasets typical of OPS experiments across multiple scales.
Scalability and Performance: Optimized for both local and cloud-based distributed environments using Dask.
Modular Workflows: Includes customizable WDL workflows for cloud platforms like Terra or Cromwell.

Key Features

Efficient Data Handling: Advanced memory management and lazy evaluation to minimize resource usage.
Command-Line Interface (CLI): Automates batch processing for seamless pipeline integration.
Customizable Outputs: Generates versatile data visualizations and summary statistics.
Notebook Examples: Practical Jupyter notebooks are included to guide users through real-world workflows.
Rich API: A comprehensive API that allows for the creation of fully customized biological data pipelines.

Typical Use Cases

Large-Scale Screening: Handling the immense data loads of genome-wide OPS projects.
Biological Discovery: Identifying and quantifying biological perturbations from high-throughput imaging.

Contributing to SCALLOPS

We welcome all forms of contributions, including bug reports, documentation improvements, and feature enhancements.

Intended Audience
- Developers
- Science/Research
Natural Language
- English
Operating System
- OS Independent
Programming Language
- Python :: 3
Topic
- Scientific/Engineering :: Bio-Informatics

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scallops-1.0.1.tar.gz (1.0 MB view details)

Uploaded Aug 4, 2026 Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

scallops-1.0.1-cp314-cp314t-win_amd64.whl (619.8 kB view details)

Uploaded Aug 4, 2026 CPython 3.14tWindows x86-64

scallops-1.0.1-cp314-cp314t-win32.whl (617.1 kB view details)

Uploaded Aug 4, 2026 CPython 3.14tWindows x86

scallops-1.0.1-cp314-cp314t-musllinux_1_2_x86_64.whl (857.3 kB view details)

Uploaded Aug 4, 2026 CPython 3.14tmusllinux: musl 1.2+ x86-64

scallops-1.0.1-cp314-cp314t-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl (865.4 kB view details)

Uploaded Aug 4, 2026 CPython 3.14tmanylinux: glibc 2.28+ x86-64manylinux: glibc 2.5+ x86-64

scallops-1.0.1-cp314-cp314t-macosx_11_0_arm64.whl (618.3 kB view details)

Uploaded Aug 4, 2026 CPython 3.14tmacOS 11.0+ ARM64

scallops-1.0.1-cp314-cp314-win_amd64.whl (617.2 kB view details)

Uploaded Aug 4, 2026 CPython 3.14Windows x86-64

scallops-1.0.1-cp314-cp314-win32.whl (614.7 kB view details)

Uploaded Aug 4, 2026 CPython 3.14Windows x86

scallops-1.0.1-cp314-cp314-musllinux_1_2_x86_64.whl (808.0 kB view details)

Uploaded Aug 4, 2026 CPython 3.14musllinux: musl 1.2+ x86-64

scallops-1.0.1-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl (814.5 kB view details)

Uploaded Aug 4, 2026 CPython 3.14manylinux: glibc 2.28+ x86-64manylinux: glibc 2.5+ x86-64

scallops-1.0.1-cp314-cp314-macosx_11_0_arm64.whl (615.2 kB view details)

Uploaded Aug 4, 2026 CPython 3.14macOS 11.0+ ARM64

scallops-1.0.1-cp313-cp313-win_amd64.whl (614.9 kB view details)

Uploaded Aug 4, 2026 CPython 3.13Windows x86-64

scallops-1.0.1-cp313-cp313-win32.whl (612.3 kB view details)

Uploaded Aug 4, 2026 CPython 3.13Windows x86

scallops-1.0.1-cp313-cp313-musllinux_1_2_x86_64.whl (807.9 kB view details)

Uploaded Aug 4, 2026 CPython 3.13musllinux: musl 1.2+ x86-64

scallops-1.0.1-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl (815.2 kB view details)

Uploaded Aug 4, 2026 CPython 3.13manylinux: glibc 2.28+ x86-64manylinux: glibc 2.5+ x86-64

scallops-1.0.1-cp313-cp313-macosx_11_0_arm64.whl (613.6 kB view details)

Uploaded Aug 4, 2026 CPython 3.13macOS 11.0+ ARM64

scallops-1.0.1-cp312-cp312-win_amd64.whl (615.2 kB view details)

Uploaded Aug 4, 2026 CPython 3.12Windows x86-64

scallops-1.0.1-cp312-cp312-win32.whl (612.4 kB view details)

Uploaded Aug 4, 2026 CPython 3.12Windows x86

scallops-1.0.1-cp312-cp312-musllinux_1_2_x86_64.whl (831.6 kB view details)

Uploaded Aug 4, 2026 CPython 3.12musllinux: musl 1.2+ x86-64

scallops-1.0.1-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl (834.7 kB view details)

Uploaded Aug 4, 2026 CPython 3.12manylinux: glibc 2.28+ x86-64manylinux: glibc 2.5+ x86-64

scallops-1.0.1-cp312-cp312-macosx_11_0_arm64.whl (614.0 kB view details)

Uploaded Aug 4, 2026 CPython 3.12macOS 11.0+ ARM64

File details

Details for the file scallops-1.0.1.tar.gz.

File metadata

Download URL: scallops-1.0.1.tar.gz
Upload date: Aug 4, 2026
Size: 1.0 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for scallops-1.0.1.tar.gz
Algorithm	Hash digest
SHA256	`287c0e69058b472d91c6b344555e4b711872af52a894e26f126e715a790c2036`
MD5	`d909fd2d148cd9cc6f74499f3b7519f6`
BLAKE2b-256	`d6b39d7ef04f25121b8f1ab2da66cff224ea6b47f4ed288bb8173cfbef858df0`

Algorithm	Hash digest
SHA256	`cc72ce90ea03f1b8159f94e59b61e26ff1c489b5963d9a9cb79d106f68fb207f`
MD5	`b558c3614589112c78bb4b5bca394263`
BLAKE2b-256	`c4acc00c0446c03bbd8b0c99ad367d8e21c0b6d3f67dacb5a610182f78a45e4c`

Algorithm	Hash digest
SHA256	`fd5d92d931d5c3140e2c4a059ee23a3a1cd69fbcacac13e92750e4eebaac18ba`
MD5	`1e048ad9234edc7feae0b2fe4a4292fe`
BLAKE2b-256	`c4a639184eeac1a3e9194dafde9d26d817f1eec3faa39bd1684405fe2466bec0`

Algorithm	Hash digest
SHA256	`e2369e237450406870c8a00012d4bb8efd628464c3a584c884782fcd878d1a06`
MD5	`242f1c0435599310e429158fca5e5208`
BLAKE2b-256	`7571b254780e725fd9b43a4dc7978803f76d79722f7879931e9e78c93eef8a4f`

Algorithm	Hash digest
SHA256	`46b42963cbd526b2d76a9641b9da7f2eaad4fa6aed8116a353e9b1ae5c72b530`
MD5	`730227e248f478ea305c4a01e4f940ce`
BLAKE2b-256	`43db4200f3e368aaa336878e78313eea9f0a9d3ffca69ddff47153a21aa329ff`

Algorithm	Hash digest
SHA256	`b5b3325245c23c8bd0cc67f42280eca0f45a230593e3024b000dac05309d6cb4`
MD5	`379dc9503ba0f55a3dcfca4a9ec1d35f`
BLAKE2b-256	`ad39a15ef7b6ef7f6ce679fb551cd1ae1fa97420f2c6728edda2fd8506063a43`

Algorithm	Hash digest
SHA256	`e0ae35d26356c751c652d43f826cbf24b8cfd3b1b382e3f2c4807b96b9450aa4`
MD5	`7b65dcf65b344f57954653e72ce53074`
BLAKE2b-256	`c4d092440385bfaa52ce8b4fe72f6503223daa6f70a1d10ab809f37de797f937`

Algorithm	Hash digest
SHA256	`871454ed80560166358a7ad296bf2c0d4c2483f9f5c78aa3720d8282a7b85531`
MD5	`3adcc688ff0554ba0b1b24b8f0304f5c`
BLAKE2b-256	`55fffab0c80314950d6ca5aa80e10ce6ecdc18df3e7c98c726ffe29ead14a9e0`

Algorithm	Hash digest
SHA256	`f61e4e53c074885468adeb9ad0234128848b1795a226d4e29442bd1b31e35292`
MD5	`9a672c1a4496d9e8d3f2045e4504c5d8`
BLAKE2b-256	`75dfeffa1509c3906afb10c60393071a5323896ff90c21dee449c65796c4debe`

Algorithm	Hash digest
SHA256	`6abc55d605c686ed36baadfa523998a6119252bd5e884e379c9a03e71ebd6873`
MD5	`ce3a00731c93c273aaa132484996cedc`
BLAKE2b-256	`25607c92b665b5c547efc28a3f78d6409b4659d8d11606a778c8f962fdddd2c6`

Algorithm	Hash digest
SHA256	`e4a95e40bced622086aabba413451c88db9964ba47fa3cc67fd9e79d2e0182b8`
MD5	`39d85f15aa20087c0748d899007db6ae`
BLAKE2b-256	`aa87b86fd9282ca08d58e302cf3d59937f41b80b10434fa88782fff5e96a0a80`

Algorithm	Hash digest
SHA256	`2a0bceec1c753c238edb8c767fb8608f7e6570a5e89479576be2cf825337f97b`
MD5	`b01d8fe8735205a691154d42519951b9`
BLAKE2b-256	`b63e3578dc578fc99237e0d13260f4e468ac3fdfc7ecae1304e2e093c5de5648`

Algorithm	Hash digest
SHA256	`6788b82d44cf5e8df62a212dc725f6246930ef6197df563535574218a4cdb28d`
MD5	`63c6d28dfe3945b1d4198f8f75d241d4`
BLAKE2b-256	`6d504e72e4c166a38ac0ce2fc519f4a77cd96d7ef6e33642b8a6278459de3722`

Algorithm	Hash digest
SHA256	`5e049998e972340fb85f5a45a380ef98aa54379e21406ea0d5fa2298a74efe07`
MD5	`423857c1284cdec0808ef43fe8c77971`
BLAKE2b-256	`75ea83d839ee97947e68fce4912ddec90ff6f5d63487ed40204b77888e7b2ef0`

Algorithm	Hash digest
SHA256	`72684a5bdd1870f261c6e8d5ed5c2e8117194210e8007837211c87e0c88927df`
MD5	`d5c1cef2e60af8801d8977e5056693eb`
BLAKE2b-256	`1b2a6a39c4eb2066d887e9f65399819edda05b1d2cd9ef1dc7653a067dcb7ad9`

Algorithm	Hash digest
SHA256	`fe0e75c56150afbd0d3e48cbf5971bf81f55dd427589cd34340c49094f81b8d1`
MD5	`49c899691bcbfb08394cb689a8ae85f7`
BLAKE2b-256	`f5d425c18a6ab32672908d5b53a2aaf9633f37fcabf2c8f71cc03c7cf662ab4b`

Algorithm	Hash digest
SHA256	`158260e6feda7b8cb3f34a52478cf936de17e64b13ff8c3ebde8ee8998f266a7`
MD5	`5c808e96d17530b3122558416fb20e51`
BLAKE2b-256	`e53ca6d2d3adad2f51fd692b49798309a837bd33aaa6b225fa473d39570b4613`

Algorithm	Hash digest
SHA256	`268fd394f702f4336c30ee37a0bce40d5a8284ea141e1fccd25ebf11c7c67a8a`
MD5	`e30bc403c517c6a5a5c20542fffca698`
BLAKE2b-256	`18bd605ac04f9fde33f030d1f2d8c995a7c829e145d82c079929726f6f5db342`

Algorithm	Hash digest
SHA256	`af1110f8bc5104447daab0c5b043b7eb1e8cb4beb42540f52a7bfe217653bbb8`
MD5	`be759048fbf2b23ff75aae527f19908b`
BLAKE2b-256	`3777c2139f4e6cd12cd278136849c3116ce3eeea709d8f1b07da86860376b2be`

Algorithm	Hash digest
SHA256	`6e98d33903a4ce58aa6fa4678e181462e62f28e7a06914be791ddea1d450329d`
MD5	`3353d22fa37a3d5b4f1f6358a577e7f1`
BLAKE2b-256	`961d0b3d3153345997c02e0cc52b5f6e9dffe9b40dc613ebe0f13105eb95fb4a`

Algorithm	Hash digest
SHA256	`4ba40f51a32d14d03a884e50f12e8d67a947c5fdf2ee60ac6092f316e7df8bd5`
MD5	`b8a9a390c157ca4e00dc32fbf8f53cab`
BLAKE2b-256	`6d687695723f022c263d142c76ac792c1d6e49512267bd890a0fc46a59191590`

scallops 1.0.1

SCALLOPS

Documentation

Repository Structure

Getting Started

Prerequisites

1. Environment Setup (Recommended)

2. Installation and Usage Options

Option 1: Install from PyPI (Standard)

Option 2: Run via Docker (GitHub Container Registry)

Option 3: Install from Source (Development)

Main Focus Areas

Key Features

Typical Use Cases

Contributing to SCALLOPS

Project links

Key dates

2 maintainers

Credits

GitHub Statistics

License expression

Requires

Provides Extra

Classifiers

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details