Skip to main content

SeMRA

Tests PyPI PyPI - Python Version PyPI - License Documentation Status Codecov status Cookiecutter template from @cthoyt Ruff Contributor Covenant DOI

The Semantic Mapping Reasoner and Assembler (SeMRA) is a Python package that provides:

  1. An object model for semantic mappings (based on SSSOM)
  2. Functionality for assembling and reasoning over semantic mappings at scale
  3. A provenance model for automatically generated mappings
  4. A confidence model granular at the curator-level, mapping set-level, and community feedback-level

We also provide the SeMRA Raw Semantic Mappings Database, a set of pre-assembled semantic mappings from hundreds of ontologies and databases, on Zenodo at https://doi.org/10.5281/zenodo.11082038 that can be rebuilt with semra build. More information here.

💪 Getting Started

Here's a demonstration of SeMRA's object, provenance, and cascading confidence model:

from semra import Reference, Mapping, EXACT_MATCH, SimpleEvidence, MappingSet, MANUAL_MAPPING

r1 = Reference(prefix="chebi", identifier="107635", name="2,3-diacetyloxybenzoic")
r2 = Reference(prefix="mesh", identifier="C011748", name="tosiben")

mapping = Mapping(
    subject=r1,
    predicate=EXACT_MATCH,
    object=r2,
    evidence=[
        SimpleEvidence(
            justification=MANUAL_MAPPING,
            confidence=0.99,
            author=Reference(
                prefix="orcid", identifier="0000-0003-4423-4370", name="Charles Tapley Hoyt"
            ),
            mapping_set=MappingSet(
                name="biomappings",
                license="https://creativecommons.org/publicdomain/zero/1.0/",
                confidence=0.90,
            ),
        )
    ],
)

Assembly

Mappings can be assembled from many source formats using I/O functions exposed through the top-level semra submodule:

import semra

# load mappings from any standardized SSSOM file as a file path or URL, via `pandas.read_csv`
sssom_url = "https://w3id.org/biopragmatics/biomappings/sssom/biomappings.sssom.tsv"
mappings = semra.from_sssom(
    sssom_url,
    license="spdx:CC0-1.0",
    mapping_set_title="biomappings",
)

# alternatively, metadata can be passed via a file/URL
mappings_alt = semra.from_sssom(
    sssom_url, metadata="https://w3id.org/biopragmatics/biomappings/sssom/biomappings.sssom.yml"
)

# load mappings from the Gene Ontology (via OBO format)
go_mappings = semra.from_pyobo("go")

# load mappings from the Uber Anatomy Ontology (via OWL format)
uberon_mappings = semra.from_pyobo("uberon")

SeMRA also implements custom importers in the semra.sources submodule. It's based on a pluggable architecture (via class-resovler) so additional custom sources can be incorporated without modifying the SeMRA source code.

from semra.sources import get_omim_gene_mappings

omim_gene_mappings = get_omim_gene_mappings()

Inference

SeMRA implements the chaining and inference rules described in the SSSOM specification. The first rule is inversions:

from semra import Mapping, EXACT_MATCH, Reference
from semra.inference import infer_reversible

r1 = Reference(prefix="chebi", identifier="107635", name="2,3-diacetyloxybenzoic")
r2 = Reference(prefix="mesh", identifier="C011748", name="tosiben")

mapping = Mapping(subject=r1, predicate=EXACT_MATCH, object=r2)

# includes the mesh -> exact match-> chebi mapping with full provenance
mappings = infer_reversible([mapping])
graph LR
    A[2,3-diacetyloxybenzoic<br/>chebi:107635] -- skos:exactMatch --> B[tosiben<br/>mesh:C011748]
    B -. "skos:exactMatch<br/>(inferred)" .-> A

The second rule is about transitivity. This means some predicates apply over chains. SeMRA further implements configuration for two-length chains and could be extended to arbitrary chains.

from semra import Reference, Mapping, EXACT_MATCH
from semra.inference import infer_chains

r1 = Reference.from_curie("mesh:C406527", name="R 115866")
r2 = Reference.from_curie("chebi:101854", name="talarozole")
r3 = Reference.from_curie("chembl.compound:CHEMBL459505", name="TALAROZOLE")

m1 = Mapping(subject=r1, predicate=EXACT_MATCH, object=r2)
m2 = Mapping(subject=r2, predicate=EXACT_MATCH, object=r3)

# infers r1 -> exact match -> r3
mappings = infer_chains([m1, m2])
graph LR
    A[R 115866<br/>mesh:C406527] -- skos:exactMatch --> B[talarozole<br/>chebi:101854]
    B -- skos:exactMatch --> C[TALAROZOLE<br/>chembl.compound:CHEMBL459505]
    A -. "skos:exactMatch<br/>(inferred)" .-> C

The third rule is generalization, which means that a more strict predicate can be relaxed to a less specific predicate, like owl:equivalentTo to skos:exactMatch.

from semra import Reference, Mapping, EXACT_MATCH
from semra.inference import infer_generalizations

r1 = Reference.from_curie("chebi:101854", name="talarozole")
r2 = Reference.from_curie("chembl.compound:CHEMBL459505", name="TALAROZOLE")

m1 = Mapping(subject=r1, predicate=EXACT_MATCH, object=r2)

mappings = infer_generalizations([m1])
graph LR
    A[talarozole<br/>chebi:101854] -- owl:equivalentTo --> B[TALAROZOLE<br/>chembl.compound:CHEMBL459505]
    A -. "skos:exactMatch<br/>(inferred)" .-> B

The third rule can actually be generalized to any kinds of mutation of one predicate to another, given some domain knowledge. For example, some resources curate oboInOwl:hasDbXref predicates when it's implied that they mean skos:exactMatch because the resource is curated in the OBO flat file format.

from semra import Reference, Mapping, DB_XREF
from semra.inference import infer_dbxref_mutations

r1 = Reference.from_curie("doid:0050577", name="cranioectodermal dysplasia")
r2 = Reference.from_curie("mesh:C562966", name="Cranioectodermal Dysplasia")
m1 = Mapping(subject=r1, predicate=DB_XREF, object=r2)

# we're 99% confident doid-mesh dbxrefs actually are exact matches
mappings = infer_dbxref_mutations([m1], {("doid", "mesh"): 0.99})
graph LR
    A[cranioectodermal dysplasia<br/>doid:0050577] -- oboInOwl:hasDbXref --> B[Cranioectodermal Dysplasia<br/>mesh:C562966]
    A -. "skos:exactMatch<br/>(inferred)" .-> B

Processing

Mappings can be processed, aggregated, and summarized using functions from the semra.api submodule:

from semra.api import filter_minimum_confidence, prioritize, project, summarize_prefixes

mappings = ...
mappings = filter_minimum_confidence(mappings, cutoff=0.7)

summary_df = summarize_prefixes(mappings)

# get one-to-one mappings between entities from the given prefixes
chebi_to_mesh = project(mappings, source_prefix="chebi", target_prefix="mesh")

# process the mappings using a graph algorithm that creates
# a "star" graph for every equivalent entity, where the center
# of the star is determined by the equivalent entity with the
# highest priority based on the given list
priority_mapping = prioritize(
    mappings,
    priority=[
        "chebi",
        "chembl.compound",
        "pubchem.compound",
        "drugbank",
    ],
)

The prioritization described by the code above works like this:

graph LR
    subgraph unprocessed [Exact Matches Graph]
    A[R 115866<br/>mesh:C406527] --- B[talarozole<br/>chebi:101854]
    B --- C[TALAROZOLE<br/>chembl.compound:CHEMBL459505]
    A --- C
    end
    subgraph star [Prioritized Mapping Graph]
    D[R 115866<br/>mesh:C406527] --> E[talarozole<br/>chebi:101854]
    F[TALAROZOLE<br/>chembl.compound:CHEMBL459505] --> E
    end
    unprocessed --> star

🏞️ Landscape Analysis

We demonstrate using SeMRA to assess the landscape of five biomedical entity types:

  1. Disease
  2. Cell & Cell Line
  3. Anatomy
  4. Protein Complex
  5. Gene

These analyses are based on declarative configurations for sources, processing rules, and inference rules that can be found in the semra.landscape module of the source code. These can be rebuilt with semra landscape, with more documentation here.

🤖 Tools for Data Scientists

SeMRA provides tools for data scientists to standardize references using semantic mappings.

For example, the drug indications table in ChEMBL contains a variety of references to EFO, MONDO, DOID, and other controlled vocabularies (described in detail in this blog post). Using SeMRA's pre-constructed disease and phenotype prioritization mapping, these references can be standardized in a deterministic and principled way.

import chembl_downloader
import semra
from semra.api import prioritize_df

# A dataframe of indication-disease pairs, where the
# "efo_id" column is actually an arbitrary disease or phenotype query
df = chembl_downloader.query("SELECT DISTINCT drugind_id, efo_id FROM DRUG_INDICATION")

# a pre-calculated prioritization of diseases and phenotypes from MONDO, DOID,
# HPO, ICD, GARD, and more.
url = "https://zenodo.org/records/15164180/files/priority.sssom.tsv?download=1"
mappings = semra.from_sssom(url)

# the dataframe will now have a new column with standardized references
prioritize_df(mappings, df, column="efo_id", target_column="priority_indication_curie")

🚀 Installation

The most recent release can be installed from PyPI with uv:

$ uv pip install semra

or with pip:

$ python3 -m pip install semra

The most recent code and data can be installed directly from GitHub with uv:

$ uv pip install git+https://github.com/biopragmatics/semra.git

or with pip:

$ python3 -m pip install git+https://github.com/biopragmatics/semra.git

👐 Contributing

Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.md for more information on getting involved.

👋 Attribution

⚖️ License

The code in this package is licensed under the MIT License.

📖 Citation

Assembly and reasoning over semantic mappings at scale for biomedical data integration
Hoyt, C. T., Karis K., and Gyori, B. M.
Bioinformatics, 2025, btaf542.

@article{hoyt2025semra,
    author = {Hoyt, Charles Tapley and Karis, Klas and Gyori, Benjamin M},
    title = {Assembly and reasoning over semantic mappings at scale for biomedical data integration},
    journal = {Bioinformatics},
    pages = {btaf542},
    year = {2025},
    month = {09},
    issn = {1367-4811},
    doi = {10.1093/bioinformatics/btaf542},
    url = {https://doi.org/10.1093/bioinformatics/btaf542},
    eprint = {https://academic.oup.com/bioinformatics/advance-article-pdf/doi/10.1093/bioinformatics/btaf542/64428329/btaf542.pdf},
}

🍪 Cookiecutter

This package was created with @audreyfeldroy's cookiecutter package using @cthoyt's cookiecutter-snekpack template.

🛠️ For Developers

See developer instructions

The final section of the README is for if you want to get involved by making a code contribution.

Development Installation

To install in development mode, use the following:

$ git clone git+https://github.com/biopragmatics/semra.git
$ cd semra
$ uv pip install -e .

Alternatively, install using pip:

$ python3 -m pip install -e .

Pre-commit

You can optionally use pre-commit to automate running key code quality checks on each commit. Enable it with:

$ uvx pre-commit install

Or using pip:

$ pip install pre-commit
$ pre-commit install

🥼 Testing

After cloning the repository and installing tox with uv tool install tox --with tox-uv or python3 -m pip install tox tox-uv, the unit tests in the tests/ folder can be run reproducibly with:

$ tox -e py

Additionally, these tests are automatically re-run with each commit in a GitHub Action.

📖 Building the Documentation

The documentation can be built locally using the following:

$ git clone git+https://github.com/biopragmatics/semra.git
$ cd semra
$ tox -e docs
$ open docs/build/html/index.html

The documentation automatically installs the package as well as the docs extra specified in the pyproject.toml. sphinx plugins like texext can be added there. Additionally, they need to be added to the extensions list in docs/source/conf.py.

The documentation can be deployed to ReadTheDocs using this guide. The .readthedocs.yml YAML file contains all the configuration you'll need. You can also set up continuous integration on GitHub to check not only that Sphinx can build the documentation in an isolated environment (i.e., with tox -e docs-test) but also that ReadTheDocs can build it too.

🧑‍💻 For Maintainers

See maintainer instructions

Initial Configuration

Configuring ReadTheDocs

ReadTheDocs is an external documentation hosting service that integrates with GitHub's CI/CD. Do the following for each repository:

  1. Log in to ReadTheDocs with your GitHub account to install the integration at https://readthedocs.org/accounts/login/?next=/dashboard/
  2. Import your project by navigating to https://readthedocs.org/dashboard/import then clicking the plus icon next to your repository
  3. You can rename the repository on the next screen using a more stylized name (i.e., with spaces and capital letters)
  4. Click next, and you're good to go!

Configuring Archival on Zenodo

Zenodo is a long-term archival system that assigns a DOI to each release of your package. Do the following for each repository:

  1. Log in to Zenodo via GitHub with this link: https://zenodo.org/oauth/login/github/?next=%2F. This brings you to a page that lists all of your organizations and asks you to approve installing the Zenodo app on GitHub. Click "grant" next to any organizations you want to enable the integration for, then click the big green "approve" button. This step only needs to be done once.
  2. Navigate to https://zenodo.org/account/settings/github/, which lists all of your GitHub repositories (both in your username and any organizations you enabled). Click the on/off toggle for any relevant repositories. When you make a new repository, you'll have to come back to this

After these steps, you're ready to go! After you make "release" on GitHub (steps for this are below), you can navigate to https://zenodo.org/account/settings/github/repository/biopragmatics/semra to see the DOI for the release and link to the Zenodo record for it.

Registering with the Python Package Index (PyPI)

The Python Package Index (PyPI) hosts packages so they can be easily installed with pip, uv, and equivalent tools.

  1. Register for an account here
  2. Navigate to https://pypi.org/manage/account and make sure you have verified your email address. A verification email might not have been sent by default, so you might have to click the "options" dropdown next to your address to get to the "re-send verification email" button
  3. 2-Factor authentication is required for PyPI since the end of 2023 (see this blog post from PyPI). This means you have to first issue account recovery codes, then set up 2-factor authentication
  4. Issue an API token from https://pypi.org/manage/account/token

This only needs to be done once per developer.

Configuring your machine's connection to PyPI

This needs to be done once per machine.

$ uv tool install keyring
$ keyring set https://upload.pypi.org/legacy/ __token__
$ keyring set https://test.pypi.org/legacy/ __token__

Note that this deprecates previous workflows using .pypirc.

📦 Making a Release

Uploading to PyPI

After installing the package in development mode and installing tox with uv tool install tox --with tox-uv or python3 -m pip install tox tox-uv, run the following from the console:

$ tox -e finish

This script does the following:

  1. Uses bump-my-version to switch the version number in the pyproject.toml, src/semra/version.py, and docs/source/conf.py to not have the -dev suffix
  2. Packages the code in both a tar archive and a wheel using uv build
  3. Uploads to PyPI using uv publish.
  4. Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
  5. Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can use tox -e bumpversion -- minor after.

Releasing on GitHub

  1. Navigate to https://github.com/biopragmatics/semra/releases/new to draft a new release
  2. Click the "Choose a Tag" dropdown and select the tag corresponding to the release you just made
  3. Click the "Generate Release Notes" button to get a quick outline of recent changes. Modify the title and description as you see fit
  4. Click the big green "Publish Release" button

This will trigger Zenodo to assign a DOI to your release as well.

Updating Package Boilerplate

This project uses cruft to keep boilerplate (i.e., configuration, contribution guidelines, documentation configuration) up-to-date with the upstream cookiecutter package. Install cruft with either uv tool install cruft or python3 -m pip install cruft then run:

$ cruft update

More info on Cruft's update command is available here.

Metadata

Release files for semra 0.3.0

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

Source distribution (sdist)

Source distribution for semra 0.3.0
File Size Uploaded
semra-0.3.0.tar.gz 116.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for semra 0.3.0
File Interpreter ABI Platform
semra-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 257.5 kB

Release files / semra-0.3.0.tar.gz

Download URL semra-0.3.0.tar.gz
Size 116.6 kB
Tags Source
SHA-256 checksum
How to use checksums
de2a8d6130f3529809c4b4dae3a16fbd8351a2d25a6c42d130aca3fcb4ca1aa1
BLAKE2b-256 checksum
How to use checksums
0be051d1a97231b04a610c7760576542932d6fff3daabfd0761b7b16fc907fd9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.8 {"installer":{"name":"uv","version":"0.12.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / semra-0.3.0-py3-none-any.whl

Download URL semra-0.3.0-py3-none-any.whl
Size 140.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
11baf433aef1592482fe76ac11abe0fed523ead79189a34325ab0a97b8e2b8a1
BLAKE2b-256 checksum
How to use checksums
fa13e8550c7c0e1d2c2ead98e508fd91d9588b3f4ef1f0332eb6509f098b62c4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.8 {"installer":{"name":"uv","version":"0.12.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

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