Skip to content

rdurnik/aoptk

Repository files navigation

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.

About

Tools to support data mining and analysis of toxicological outcomes.

Resources

License

Contributing

Stars

2 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors