Skip to main content

Data Curation in Polaris

Project description

Auroris

PyPI Conda PyPI - Downloads Conda PyPI - Python Version

test release code-check doc

Auroris is a Python library designed to assist researchers and scientists in managing, cleaning, and preparing data relevant to drug discovery. Auroris will implement a range of techniques to handle, transform, filter, analyze, or visualize the diverse data types commonly encountered in drug discovery.

Currently, Auroris supports curation for small molecules, with plans to extend to other modalities in drug discovery. The curation module for small molecules includes:

  • 🗄️ Molecule Standardization: Ensures that each molecule is represented in a uniform and unambiguous form.

  • 🏷️ Detection of Duplicate Molecules with Contradictory Labels: Identifies and resolves inconsistencies in activity data for each molecule.

  • ⛰️ Detection of Activity Cliffs Between Stereoisomers: Identifies significant differences in activity between stereoisomers.

  • 🔍Outlier Detection and Visualization: Detects and visualizes outliers in molecular activity data.

  • 📽️ Visualization of Molecular Distribution in Chemical Space: Provides graphical representations of molecular distributions.

Reproducibility and transparency are core to the mission of Polaris. That’s why with Auroris, you can also automatically generate detailed reports summarizing the changes that happened to a dataset during curation. Through an intuitive API, you can easily define complex curation workflows. Once defined, that workflow is serializable and thus reproducible so you can transparently share how you curated the dataset.

Getting started

from auroris.curation import Curator
from auroris.curation.actions import MoleculeCuration, OutlierDetection, Discretization

# Define the curation workflow
curator = Curator(
    steps=[
        MoleculeCuration(input_column="smiles"),
        OutlierDetection(method="zscore", columns=["SOL"]),
        Discretization(input_column="SOL", thresholds=[-3]),
    ],
    parallelized_kwargs = { "n_jobs": -1 }
)

# Run the curation
dataset, report = curator(dataset)

Run curation with command line

A Curator object is serializable, so you can save it to and load it from a JSON file to reproduce the curation.

auroris [config_file] [destination] --dataset-path [data_path]

Documentation

Please refer to the documentation, which contains tutorials for getting started with auroris and detailed descriptions of the functions provided.

Installation

You can install auroris using conda/mamba/micromamba:

conda install -c conda-forge auroris

You can also use pip:

pip install auroris

Development lifecycle

Setup dev environment

conda env create -n auroris -f env.yml
conda activate auroris

pip install --no-deps -e .
Other installation options
Alternatively, using [uv](https://github.com/astral-sh/uv):
```shell
uv venv -p 3.12 auroris
source .venv/auroris/bin/activate
uv pip compile pyproject.toml -o requirements.txt --all-extras
uv pip install -r requirements.txt 
```   

Tests

You can run tests locally with:

pytest

License

Under the Apache-2.0 license. See LICENSE.

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

auroris-0.1.9.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

auroris-0.1.9-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

Details for the file auroris-0.1.9.tar.gz.

File metadata

  • Download URL: auroris-0.1.9.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for auroris-0.1.9.tar.gz
Algorithm Hash digest
SHA256 bd8d1f6161246516be783bca6db704a4efd2e4985dc9b017476fcdc1da3d3de7
MD5 a30a3b0067f829a92297d9d80751ae79
BLAKE2b-256 dbc06991de32c474c71c67995fabdc00c30782292080fa5f4bab28033993f212

See more details on using hashes here.

File details

Details for the file auroris-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: auroris-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 35.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for auroris-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 692cd8ac594f9e712b2bbf1345c1541329cb34254e95a1332d369e21799bfb85
MD5 485af4840403721f6da594590b5a148d
BLAKE2b-256 63e873f8029d149c12f0f6ff1d2a09a0533298fb59f4fc74f8641e5387223f1a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page