Skip to main content

scigantic-comptox

CI PyPI PyPI - Python Version License

Query EPA's CompTox Chemicals Dashboard from Python. Two halves, and only one of them needs anything from you:

  • ToxCast bioactivity, from a public S3 mirror over DuckDB. No API key, no download, no local database.
  • Live Chemical/Hazard/Exposure lookups, over EPA's own CCTE REST API. Optional, and requires your own EPA API key.
import scigantic_comptox as comptox

df = comptox.bioactivity(dtxsid="DTXSID7020182", hitc=1.0)

That query runs against s3://scigantic-comptox over DuckDB's httpfs extension.

Installation

$ pip install scigantic-comptox

What's in the bioactivity mirror

Every row is the winning dose-response model plus hit-call for one (chemical, ToxCast assay endpoint) pair, from EPA's invitrodb v4.3 mc5-6_winning_model_fits summary tier: AC50, potency, top, confidence bounds, and hitc/hitcall (active/inactive/ambiguous). This is the same level of detail as PubChem's own concise BioAssay tables, deliberately not the raw well-level plate reads or the full set of losing candidate curve models EPA also publishes (mc4_all_model_fits) -- that table is what makes EPA's own "summary" download 7GB instead of the ~600MB actually mirrored here; almost nobody needs the losing models, they need the winner.

comptox.bioactivity(aeid=1114, limit=5)

EPA's export uses the literal string "NA" for missing values in several columns (including dsstox_substance_id), not a real SQL NULL -- filtering with IS NOT NULL silently misses these. bioactivity() normalizes this (NULLIF(..., 'NA')) so a real NULL check works as expected; it also casts columns EPA ships as text purely because of those "NA" strings (ac50, bmd, top, and others) to real DOUBLEs. Use bioactivity_raw() if you want EPA's exact upstream types instead.

p_ac50/p_bmd are computed log-potency columns, the same shape as scigantic-chembl's pchembl_value and scigantic-bindingdb's p_affinity: 6 - log10(value_in_uM), higher meaning more potent. Computed only where conc_unit is verified 'uM' (98.8% of rows) -- a real 0.09% carry 'mg/l' instead, a mass-based unit this table can't convert correctly without a molecular weight, so those stay NULL rather than getting a silently wrong value.

Batch lookups

The mirror isn't sorted or partitioned by chemical id, so bioactivity(dtxsid=...) pays close to a full scan of the table on every call. Fine for one lookup, slow for a batch -- use bioactivity_many() instead:

comptox.bioactivity_many(["DTXSID7020182", "DTXSID2021868", "DTXSID3021805"])

Measured on the real mirror: 50 chemicals looped through bioactivity() took 61.9s; the same 50 as one bioactivity_many() call took 4.8s -- 13x faster, and the gap grows with batch size.

PubChem's own ToxCast submission data

EPA publishes its per-assay-endpoint bioactivity data pre-formatted for submission to PubChem's BioAssay system, alongside each invitrodb release. This wraps the consolidated version of that file:

comptox.pubchem_bridge(dtxsid="DTXSID7020182")
comptox.pubchem_bridge_many(["DTXSID7020182", "DTXSID2021868"])  # same batching win as above

Despite the name, this table has no PubChem CID in it -- tx_sample_id is EPA's own ToxCast sample id, not something you can resolve back into a CID. For an actual chemical-to-PubChem cross-reference, see Chemical structures below.

Reference tables

EPA publishes four small reference files alongside the bioactivity fact table -- target/design metadata, gene mapping, cytotoxicity context, and QC flags. All four are mirrored here too, under 3MB combined:

comptox.assay_annotations(intended_target_family="cyp")   # filter assays by target family, not by string-matching assay names
comptox.assay_target_mappings(official_symbol="CYP2D6")   # real Entrez gene ids and gene symbols per assay
comptox.cytotox(dtxsid="DTXSID7020182")                    # is this chemical's hit call near its cytotoxic concentration?
comptox.analytical_qc(dtxsid="DTXSID7020182")               # sample QC pass/caution, plus molecular weight/logKow/vapor pressure

Writing your own SQL

comptox.query("SELECT ...") and comptox.connect() run against the same bioactivity/pubchem_bridge views the functions above use, including the "NA"-normalization. dtxsid works directly in your own SQL too, not just as a Python parameter name:

comptox.query("SELECT dtxsid, aeid, hitc FROM bioactivity WHERE dtxsid = 'DTXSID7020182'")

Chemical structures

Real structure data for every chemical this mirror covers -- SMILES, InChI, InChIKey, formula, molecular weight -- sourced from PubChem, not EPA's own DSSTox bulk distribution:

comptox.structures(dtxsid="DTXSID7020182")
comptox.structures_many(["DTXSID7020182", "DTXSID2021868"])

DSSTox's bulk distribution turned out to be a large, unstructured institutional drive with no clean single file to mirror -- a real dead end, not skipped for convenience. EPA's live Chemical API could resolve structures too, but has an unresolved data-use question for bulk redistribution (no public Terms of Service or Data Use Agreement could be found for the API itself), not something worth guessing at instead of asking EPA directly. PubChem sidesteps both problems: fully open, no key, and every DTXSID here was resolved live against PubChem's own compound search, which indexes DTXSID as a synonym.

Real coverage, not assumed: 9,238 of 9,801 distinct chemicals resolved (94.3%). The rest genuinely have no PubChem match under that identifier. comptox.releases() reports structures_source="pubchem" and the real structures_coverage fraction, so this doesn't get mistaken for EPA's own canonical DSSTox data.

The live REST half: bring your own EPA API key

EPA's CCTE API needs one, and deliberately doesn't hand out a shared one: their own docs describe it as "an individual API key" that "uniquely identifies the user," issued by emailing ccte_api@epa.gov rather than self-serve signup. EPA's own reference client, ctx-python, never embeds a key either. This package follows the same rule -- no key ships with it, and none is proxied on your behalf.

$ export COMPTOX_API_KEY=your-key-here
comptox.chemical_detail("DTXSID7020182")
comptox.hazard_toxval("DTXSID7020182")
comptox.exposure_httk("DTXSID7020182")

Calling any of these without a key raises MissingApiKeyError with a link to how to get one, not a bare 401. Requests are retried with backoff on 429/5xx, and responses are cached for 30 days by default (the opposite default from the mirror half's caching, see below) -- EPA's API has no documented rate limit, but it's still a live government service, not an unlimited public mirror, so repeatedly re-fetching the same lookup in a loop is worth avoiding by default.

Endpoint coverage here is intentionally a starting set (one real, verified path per microservice), not a full reimplementation of ctx-python -- that package already covers Chemical/Exposure/Hazard comprehensively. This package's actual differentiator is the bioactivity mirror above, which ctx-python doesn't cover at all.

Working offline (mirror half)

Off by default, since zero setup is the whole point of the mirror:

comptox.enable_cache()
df = comptox.pubchem_bridge()  # downloads the file once, then reads from disk

Downloads to ~/.cache/scigantic-comptox (override with enable_cache(cache_dir=...) or the SCIGANTIC_COMPTOX_CACHE environment variable). Concurrent callers racing the first download of the same file wait for it rather than each downloading their own copy.

connect(), query(), and bioactivity() don't participate in this (registering the underlying views eagerly would mean the first call for any release downloads the full ~600MB regardless of what the query actually touches); use comptox.cache_resolve("v4_3/derived/pubchem_bridge.parquet") to cache a specific file yourself.

The live REST half has its own separate cache, ON by default (comptox.disable_ctx_cache() to turn it off) -- see above for why the two halves use opposite defaults.

What's mirrored

comptox.releases()
release bioactivity pubchem bridge reference tables structures
v4_3 yes yes yes yes (PubChem-sourced, 94.3% coverage)

This table isn't hardcoded. releases() reads a small manifest published alongside each mirror run.

Command line

$ scigantic-comptox info
$ scigantic-comptox query "SELECT count(*) FROM bioactivity" --release v4_3

License

MIT-0. See LICENSE. This covers the code in this package only.

Data license

EPA's invitrodb v4.3 (ToxCast bioactivity data) is CC0 -- public domain, no attribution or share-alike terms to track. A courtesy citation is appreciated, not required: Filer, D.L. et al. (2017), tcpl: the ToxCast pipeline for high-throughput screening data, Bioinformatics, doi:10.1093/bioinformatics/btw680.

structures() is sourced from PubChem, not EPA -- PubChem is a US government (NCBI/NLM) resource, and information on NLM's own web properties is public domain and freely redistributable (NCBI website and data usage policies), the same status the rest of this package's EPA data has.

Download files

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

Source Distribution

scigantic_comptox-0.3.0.tar.gz (32.2 kB view details)

Uploaded Source

Built Distribution

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

scigantic_comptox-0.3.0-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

Details for the file scigantic_comptox-0.3.0.tar.gz.

File metadata

  • Download URL: scigantic_comptox-0.3.0.tar.gz
  • Upload date:
  • Size: 32.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.16

File hashes

Hashes for scigantic_comptox-0.3.0.tar.gz
Algorithm Hash digest
SHA256 2a435a78b406156d10059a379dc94793f2a07f55972d0b42df56cfe860d2f743
MD5 3b1fa3c99142d29222a5943e5441dfca
BLAKE2b-256 ffb589f230b2dbf78b7b9f69b8310fe3ce3b00d096af7e3964c7ba9218c292cc

See more details on using hashes here.

File details

Details for the file scigantic_comptox-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for scigantic_comptox-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6ab5d1dfd1b54f5d7b8f46e53cab133ca49fafe7a7935048d60cf035d037ad66
MD5 d6b9011d1234a0f5d5e5170e66578b2c
BLAKE2b-256 11664abb8f20c1d5fd6ebf516f8253a788c87fd9df769347d2098c9bb7e6050c

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page