A tool to convert IUPAC representation of glycans into SMILES strings
Project description
GlyLES
A tool to convert IUPAC representation of Glycans into SMILES representation. This repo is still in the development phase; so, feel free to report any errors or issues. The code is available on github and the documentation can be found on ReadTheDocs.
Specification and (current) Limitations
The exact specification we're referring to when talking about "IUPAC representations of glycan" or "IUPAC-condensed", is given in the "Notes" section of this website. But as this package is still in the development phase, not everything of the specification is implemented yet (especially not all side chains you can attach to monomers). The structure of the glycan can be represented as a tree of the monosaccharides with maximal branching factor 4, i.e., each monomer in the glycan has at most 4 children.
Installation
So far, this package can only be downloaded from the python package index. So the installation with pip
is very easy.
Just type
pip install glyles
and you're ready to use it as described below. Use
pip install --upgrade glyles
to upgrade the glyles package to the most recent version.
Basic Usage
As a Python Package
Convert the IUPAC into a SMILES representation using the handy convert
method
from glyles import convert
convert(glycan="Man(a1-2)Man", output_file="./test.txt")
You can also use the convert_generator
method to get a generator for all SMILES:
from glyles import convert_generator
for smiles in convert_generator(glycan_list=["Man(a1-2)Man a", "Man(a1-2)Man b"]):
print(smiles)
For more examples of how to use this package, please see the notebooks in the examples folder and checkout the documentation on ReadTheDocs.
In the Commandline
As of version 0.5.9, there is a commandline interface to GlyLES which is automatically installed when installing GlyLES through pip. The CLI is open for one or multiple IUPAC inputs as individual arguments. Due to the syntax of the IUPAC-condensed notation and the argument parsing in commandlines, the IUPAC strings must be given in quotes.
glyles -i "Man(a1-2)Man" -o test_output.txt
glyles -i "Man(a1-2)Man" "Fuc(a1-6)Glc" -o test_output.txt
File-input is also possible.
glyles -i input_file.txt -o test_output.txt
Providing multiple files and IUPAC-condensed names is als supported.
glyles -i input_file1.txt "Man(a1-2)Man" input_file2.txt input_file13.txt "Fuc(a1-6)Glc" -o test_output.txt
Notation of glycans
There are multiple different notations for glycans in IUPAC. So, according to the
SNGF specification, Man(a1-4)Gal
, Mana1-4Gal
, and Mana4Gal
all describe the same disaccharide. This is also covered in this package as all three notations will be parsed into the
same tree of monosaccharides and result in the same SMILES string.
This is also described more detailed in a section on ReadTheDocs.
Poetry
To develop this package, we use the poetry package manager (see here for detailed instruction). It has basically the same functionality as conda but supports the package management better and also supports distinguishing packages into those that are needed to use the package and those that are needed in the development of the package. To enable others to work on this repository, we also publish the exact specifications of our poetry environment.
Citation
If you use GlyLES in your work, please cite
@article{joeres2023glyles,
title={GlyLES: Grammar-based Parsing of Glycans from IUPAC-condensed to SMILES},
author={Joeres, Roman and Bojar, Daniel and Kalinina, Olga V},
journal={Journal of Cheminformatics},
volume={15},
number={1},
pages={1--11},
year={2023},
publisher={BioMed Central}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file glyles-1.0.0.tar.gz
.
File metadata
- Download URL: glyles-1.0.0.tar.gz
- Upload date:
- Size: 72.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.9.20 Linux/5.15.153.1-microsoft-standard-WSL2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65f76aeb425f936ea6eb73ae9ae9f649484eec3290b303115259d82c34d23f17 |
|
MD5 | d0b10943d0aa9b9342a1c4ba6777cc41 |
|
BLAKE2b-256 | bd097e7cf8a36301d5a2b99c66d51378f41c3083d34ae91fab05a334083e1d06 |
File details
Details for the file glyles-1.0.0-py3-none-any.whl
.
File metadata
- Download URL: glyles-1.0.0-py3-none-any.whl
- Upload date:
- Size: 80.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.9.20 Linux/5.15.153.1-microsoft-standard-WSL2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 272a82892baa1c11727e420808a791fed37ec772ec72f619d0ee402341671944 |
|
MD5 | 9216de2b76b0efd05e87746a5e84b0a9 |
|
BLAKE2b-256 | 24316bf84139d49f8cb51d144e84a94d9fd8f65ffda6369a6438db5565bce6be |