Skip to main content

pgscatalog.calc

Run pytest on pgscatalog.calc Documentation Status

This Python package contains:

  • CLI applications to aggregate and adjust calculated polygenic scores (PGS) in the context of genetic ancestry similarity
  • library classes and functions for working with calculated PGS and PCA data

[!NOTE]

  • This package doesn't contain functionality to calculate a PGS from target genomes and scoring files
  • If you want software that does that, check out the PGS Catalog Calculator
  • This package is focused on PGS aggregation and normalisation, and is used internally by the PGS Catalog Calculator
Application Description Link
pgscatalog-aggregate Aggregate calculated PGS split across multiple files README
pgscatalog-ancestry-adjust Adjust calculated PGS in the context of genetic ancestry README

If you want to write Python code to work with PGS data, the library may be helpful for you.

Installation

install with bioconda

or install via pip:

$ pipx install pgscatalog.calc

Documentation

Documentation is available at https://pygscatalog.readthedocs.io/.

Developer instructions

You'll need nox and uv installed.

To get set up with a development environment run:

$ nox -s dev
$ source .venv/bin/activate

This will create a virtual environment in the current directory.

$ pgscatalog-aggregate --help

nox can also be used to run tests and lint the package:

$ nox

Metadata

Release files for pgscatalog.calc 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pgscatalog.calc 0.3.1
File Size Uploaded
pgscatalog_calc-0.3.1.tar.gz 727.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pgscatalog.calc 0.3.1
File Interpreter ABI Platform
pgscatalog_calc-0.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 755.8 kB

Release files / pgscatalog_calc-0.3.1.tar.gz

Download URL pgscatalog_calc-0.3.1.tar.gz
Size 727.4 kB
Tags Source
SHA-256 checksum
How to use checksums
2dea2426c0bdf579662bf5b42fd2b047e662d5bc612bf2a39cb433142ffe5206
BLAKE2b-256 checksum
How to use checksums
5c209b12437469ff1ca51182c5c01c9bcf0ff68e7d01407cccada4e78e19a27c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 22, 2025.

Transparency log

Release files / pgscatalog_calc-0.3.1-py3-none-any.whl

Download URL pgscatalog_calc-0.3.1-py3-none-any.whl
Size 28.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
95c456a34f8a9e9362ebf8d47ed8e88ccc1735035a54db0ebef57baf216c2b35
BLAKE2b-256 checksum
How to use checksums
bb882aae0d5689d3b825c5957dd240fe0a327c4ea9ed7a8c905441a2c94a97f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 22, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.3.1 This release

2 release files

0.3.0

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release 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