Skip to main content

Tools to support data mining for the development of (q)AOPs

Project description

github license badge workflow pypi badge Bioconda DOI workflow scq badge workflow scc badge Documentation Status build cffconvert sonarcloud

AOP-toolkit (aoptk)

AOP-toolkit (aoptk) is a Python package for mining and analyzing toxicological and biomedical literature. Originally developed to support the construction of Adverse Outcome Pathways (AOPs), it provides general-purpose tools for retrieving, processing, and analyzing scientific publications.

The toolkit enables users to collect literature from databases such as PubMed Central and Europe PMC, extract information from full-text articles, analyze unstructured text and images using large language models, and normalize chemical names across publications to improve data consistency and interoperability.

How to use aoptk

Installation

You can install aoptk in multiple ways depending on your workflow.

Install from PyPI (with uv)

python -m pip install aoptk

Install from BioConda

conda install -c bioconda aoptk

Install from source (with uv)

git clone git@github.com:rdurnik/aoptk.git
cd aoptk
uv sync --frozen
uv pip install .

Dev Container (developer environment)

This repo includes a lightweight VS Code Dev Container in the .devcontainer/ folder. Rebuild it via VS Code: "Dev Containers: Rebuild Container".

To configure API access, copy .env.example to .env and fill in the required values before rebuilding the container.

Documentation

See our Read the Docs.

Contributing

If you want to contribute to the development of aoptk, have a look at the contribution guidelines.

Credits

This package was created with Copier and the NLeSC/python-template.

Funding

This software was developed with support from the European Union’s Horizon 2020 research and innovation programme under grant agreement No. 857560 (CETOCOEN Excellence) and from MEYS under grant SALVAGE (CZ.02.01.01/00/22_008/0004644). The content reflects only the author’s view, and the European Commission is not responsible for any use that may be made of the information it contains. Authors also thank the RECETOX Research Infrastructure (No LM2023069) financed by the Ministry of Education, Youth and Sports for supportive background.

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

aoptk-0.5.0.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

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

aoptk-0.5.0-py3-none-any.whl (44.5 kB view details)

Uploaded Python 3

File details

Details for the file aoptk-0.5.0.tar.gz.

File metadata

  • Download URL: aoptk-0.5.0.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aoptk-0.5.0.tar.gz
Algorithm Hash digest
SHA256 62923276cc9abcfdeb543d5bd9be493f31046a836a3911717f0797f37da58b7d
MD5 2c7a24fbf00fe033f9a47dfc0e2f0394
BLAKE2b-256 9dd22165a2c85e020e41a502c87833fe6476f69d1730a4e9ba7ff42f8a96669f

See more details on using hashes here.

Provenance

The following attestation bundles were made for aoptk-0.5.0.tar.gz:

Publisher: publish.yml on rdurnik/aoptk

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

File details

Details for the file aoptk-0.5.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for aoptk-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36436ea99ae50feaf77011acff7fe3d5d3b792f50ab90c12e44c040c8885b90e
MD5 3a8251b2342a84f48a800e0427e91fd1
BLAKE2b-256 abc77c635f6562dee8b414cca05b283ad3dcce3e7372f7be5b2b6bbeb87a3c6a

See more details on using hashes here.

Provenance

The following attestation bundles were made for aoptk-0.5.0-py3-none-any.whl:

Publisher: publish.yml on rdurnik/aoptk

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