Skip to main content

The package find the best chromatography based on properties of the mixture

Project description

Project Logo

Chrfinder

Project overview

PyPI version License PyPI - Python Version Coverage Badge

Welcome to Chrfinder! This project automates the selection of the most suitable chromatography technique . By simply providing the names of the molecules in the mixture, the code retrieves their physicochemical properties from PubChem (web source) and determines the optimal chromatography method based on these properties. It also gives the optimal conditions.

✅ Benefits

  • 🚀 Efficiency: Automates the property retrieval and decision-making process, saving time and reducing manual effort.
  • 🎯 Accuracy: Utilizes precise physicochemical data to ensure the most suitable chromatography technique is chosen.
  • 🌐 Versatility: Supports a wide range of organic compounds and chromatography methods (PubChem database).

⚙ Installation

To get started with Chrfinder, you can follow these steps: Create a new environment, you may also give the environment a different name.

conda create -n Chrfinder python=3.10 

Then install it through pypi (easy, recommended):

conda activate Chrfinder
pip install Chrfinder

You also have the choice to install it without pypi:

git clone https://github.com/Averhv/Chrfinder.git
cd Chrfinder
pip install .

🛠️ Installation for Development

If you want to contribute to Chrfinder or run the tests and get coverage, you can install the package in editable mode along with the necessary dependencies for testing and documentation. The following script allows the changes to be reflected immediately:

git clone https://github.com/Averhv/Chrfinder.git
cd Chrfinder
pip install -e ".[test,doc]"

Then you need to run the tests as follow in your terminal:

pip install tox
tox

Test result: 15 passed in ~20s

📒 Features

The following should be written in the terminal in python mode:

from Chrfinder import main

Running the main file asks for molecules through Tkinter and returns the best chromatography.

main()

🌐 Optional functions

  • find_pka(inchikey) Finds the pKa value for a compound using its InChIKey.
from Chrfinder import find_pka

inchikey = "XEFQLINVKFYRCS-UHFFFAOYSA-N"
find_pka(inchikey)
  • find_boiling_point(name) Finds the boiling point for a compound by name.
from Chrfinder import find_boiling_point

compound_name = "Ethanol"
find_boiling_point(compound_name)
  • get_df_properties() Get a DataFrame of properties for a mixture of compounds.
from Chrfinder import get_df_properties

mixture = ["Acetone", "Ethanol", "Methanol"]
get_df_properties(mixture, verbose=True)

Work in progress...

  • Efficiency: build a database;
  • Research thermostability in lab to improve precision
  • Taking into account multiple pKa values for polyacids for exemple;
  • Optimize the research: search only one time the same name;

🫱🏽‍🫲🏼 Contributing

Contributions are welcome! Please submit a pull request or open an issue to discuss any changes.

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

chrfinder-1.0.0.tar.gz (3.1 MB view details)

Uploaded Source

Built Distribution

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

chrfinder-1.0.0-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

Details for the file chrfinder-1.0.0.tar.gz.

File metadata

  • Download URL: chrfinder-1.0.0.tar.gz
  • Upload date:
  • Size: 3.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.13

File hashes

Hashes for chrfinder-1.0.0.tar.gz
Algorithm Hash digest
SHA256 00aaea4ad79b9d12b883d085e5a7cbd1695bac7ba1004596758dcb56a6ddf391
MD5 3ad0d8239e9a72a6ec6a2153c4d2045a
BLAKE2b-256 626bcb484497efc95a44ca1bbbdc0fa7d9b1f40d760dda3686003ac41a14ffcf

See more details on using hashes here.

File details

Details for the file chrfinder-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: chrfinder-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 17.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.13

File hashes

Hashes for chrfinder-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9aacb1c57229d9f35bd1505a78a8a70a2c8931db280b08052982ec3087235b6
MD5 7b820927312f19122d74cc959e088547
BLAKE2b-256 da1f589d63a47cfa882893f57009803c856f856ce28b58ceea8bc16d7969ace3

See more details on using hashes here.

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