Skip to main content

A composable app infrastructure for scientific computing

Project description

scinexus

Coverage Status Codacy Badge Ruff CI PyPI Downloads

scinexus is a framework for rapid development of data processing applications. It enables interoperability between objects through defined data types, allowing development of scientific domain app ecosystems. Just as attrs and dataclasses use type hints to simplify data type definition, scinexus uses them to simplify writing best-practice scientific algorithms.

Many scientific problems require repeating calculations across many files or database records. Such tasks suit data-level parallelism, but writing robust, maintainable code for them is often tedious and quickly becomes complex.

As the Unix philosophy articulates, writing algorithms that do one thing well and can be composed together through piping data of known type is a Very Good Thing™.

scinexus encourages this design pattern and eliminates the boilerplate. We leverage the Python type annotation system to govern the compatibility (composability) of different applications. This enables in-process composition of your applications with validation of the consistency of the pipeline and the consistency of the data being run through it.

scinexus is designed for scientific reproducibility. Scientific computations should record all conditions needed to reproduce an analysis. scinexus reduces the effort by intercepting all arguments (including defaults) used in app construction and logging the resulting app state.

Examples

Developers can choose inheriting from a base class or use the scinexus.define_app decorator to make composable apps. The following examples show simple composition

Loading files so missing data does not cause a crash
from scinexus import define_app


@define_app(app_type="loader")
def read_json(path: str) -> dict:
    import json

    with open(path) as f:
        return json.load(f)


@define_app
def validate(data: dict, required_field: str) -> dict:
    if required_field not in data:
        # this becomes a NotCompleted sentinel object
        # your run doesn't crash!
        raise ValueError(f"missing {required_field!r} field")
    return data


app = read_json() + validate(required_field="name")

You can apply app to a single file path as app(filepath), or operate in parallel (and show a progress bar) on a sequence of file paths as

results = list(app.as_completed(["some_file_path.json", "some_other_file_path.json"], parallel=True, show_progress=True)
A contrived numerical example
from scinexus import define_app


@define_app
def normalise(values: list[float]) -> list[float]:
    lo, hi = min(values), max(values)
    return [(v - lo) / (hi - lo) for v in values]


@define_app
def threshold(values: list[float]) -> list[bool]:
    return [v > 0.5 for v in values]


app = normalise() + threshold()
app([1.0, 5.0, 3.0, 9.0])
A configurable app
from scinexus import define_app


@define_app(app_type="loader")
def load_csv(path: str) -> list[dict]:
    import csv

    with open(path) as f:
        return list(csv.DictReader(f))


@define_app
class summarise:
    def __init__(self, column: str) -> None:
        """column contains the values to produce summary stats for"""
        self.column = column

    def main(self, rows: list[dict]) -> dict[str, float]:
        vals = [float(r[self.column]) for r in rows]
        return {"mean": sum(vals) / len(vals), "min": min(vals), "max": max(vals)}


app = load_csv() + summarise(column="price")

Features

  • Type checking at composition time
  • Durable computing -- failures recorded as NotCompleted records, not exceptions
  • Data-level parallel execution with pluggable backends (stdlib, loky, MPI, or custom)
  • Progress bars (tqdm or rich)
  • Automated logging and citation tracking
  • Checkpointing via data stores (directory, SQLite)

Installation

pip install scinexus

The scinexus origin story

The app framework and utility functions in scinexus incubated inside cogent3 from March 2019, accumulating over seven years of development, testing, and real-world use in computational genomics before being extracted into a standalone package. The design is mature and has underpinned analyses in published studies.

The extraction into scinexus makes the infrastructure available to any scientific Python project, free of the cogent3 dependency. See the changelog for a detailed list of changes from the cogent3 app infrastructure.

We acknowledge here that many members of the cogent3 community contributed to the code that now lives here, including @GavinHuttley, @rmcar17, @Nick-Foto, @KatherineCaley, @fredjaya, and @khiron.

Project details


Download files

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

Source Distribution

scinexus-2026.5.18.tar.gz (242.6 kB view details)

Uploaded Source

Built Distribution

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

scinexus-2026.5.18-py3-none-any.whl (54.8 kB view details)

Uploaded Python 3

File details

Details for the file scinexus-2026.5.18.tar.gz.

File metadata

  • Download URL: scinexus-2026.5.18.tar.gz
  • Upload date:
  • Size: 242.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scinexus-2026.5.18.tar.gz
Algorithm Hash digest
SHA256 5b46c1f562f11218f558d863e1dc570e8b194385422473a5927cb45ad6ea63ca
MD5 25b07af7530699c069cce344106f4fa2
BLAKE2b-256 c97d2220af7ff7064700b80a74dbe039fbda5070e01184d2f3fb661fe4d7bc9f

See more details on using hashes here.

Provenance

The following attestation bundles were made for scinexus-2026.5.18.tar.gz:

Publisher: release.yml on cogent3/scinexus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scinexus-2026.5.18-py3-none-any.whl.

File metadata

  • Download URL: scinexus-2026.5.18-py3-none-any.whl
  • Upload date:
  • Size: 54.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scinexus-2026.5.18-py3-none-any.whl
Algorithm Hash digest
SHA256 d73fb8bc56223262e80da91a6a88a2ef652f30133d91ce7f1b90ee27c02b8ecf
MD5 1926c02a52cd1503b72b21fd10f8650a
BLAKE2b-256 7322cefd16fd71db6076325662cee43d43c2d2bf8bf311dbbe3bfb0ba4379393

See more details on using hashes here.

Provenance

The following attestation bundles were made for scinexus-2026.5.18-py3-none-any.whl:

Publisher: release.yml on cogent3/scinexus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page