# RDF READER
[](https://coveralls.io/github/deepmatterltd/rdfreader)
[](https://results.pre-commit.ci/latest/github/deepmatterltd/rdfreader/main)
[](https://github.com/deepmatterltd/rdfreader/actions?workflow=test)
[](https://github.com/deepmatterltd/rdfreader/blob/master/LICENSE)
[](https://github.com/python/black)
[](https://pypi.python.org/pypi/rdfreader/)
## User Guide
### Installation
``` bash
pip install rdfreader
```
### Basic Usage
``` python
from rdfreader import RDFParser
rdf_file_name = "reactions.rdf"
with open(rdf_file_name, "r") as rdf_file:
# create a RDFParser object, this is a generator that yields Reaction objects
rdfreader = RDFParser(
rdf_file,
except_on_invalid_molecule=False, # will return None instead of raising an exception if a molecule is invalid
except_on_invalid_reaction=False, # will return None instead of raising an exception if a reaction is invalid
)
for rxn in rdfreader:
if rxn is None:
continue # the parser failed to read the reaction, go to the next one
# rxn is a Reaction object, it is several attributes, including:
print(rxn.smiles) # reaction SMILES string
print(rxn.properties) # a dictionary of properties extracted from the RXN record
reactants = rxn.reactants # a list of Molecule objects
products = rxn.products
solvents = rxn.solvents
catalysts = rxn.catalysts
# Molecule objects have several attributes, including:
print(reactants[0].smiles)
print(reactants[0].properties) # a dictionary of properties extracted from the MOL record (often empty)
reactants[0].rd_mol # an RDKit molecule object
```
## Developer Guide
The project is managed and packaged using [poetry](https://python-poetry.org/docs/#installation).
### Installation
``` bash
git clone https://github.com/deepmatterltd/rdfreader
poetry install # create a virtual environment and install the project dependencies
pre-commit install # install pre-commit hooks, these mostly manage codestyle
```
### Contributions
Contributions are welcome via the [fork and pull request model](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).
Before you commit changes, ensure these pass the hooks installed by pre-commit. This should be run automatically on each commit if you have run `pre-commit install`, but can be run manually from the terminal with `pre-commit run`.
### Releases
Releases are managed by GitHub releases/workflow. The version number in the pyproject file should ideally be kept up to date to the current release but is ignored by the release workflow.
To release a new version:
- Update the pyproject.toml version number.
- Push the changes to GitHub and merge to main via a pull request.
- Use the github website to create a release. Tag the commit to be released with a version number, e.g. v1.2.3. The tag should be in v*.*.* and match the version number in the pyproject.toml file.
- When the release is published, a github workflow will run, build a wheel and publish it to PyPI.
### Example Data
You can find example data in the `test/resources directory`. `spresi-100.rdf` contains 100 example records from SPRESI.
Raw data
{
"_id": null,
"home_page": "https://www.deepmatter.io",
"name": "rdfreader",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "chemistry,rdkit,rdf,rxn,mol,reaction,molecule,reader,parser,deepmatter,ctab,cheminformatics",
"author": "deepmatter",
"author_email": "enquiries@deepmatter.io",
"download_url": "https://files.pythonhosted.org/packages/69/cd/cdb4e57c5346f8470238ebfd4299a18f2943cd6c6ef8b1e632d0a64143b1/rdfreader-1.0.2.tar.gz",
"platform": null,
"description": "# RDF READER\n\n[](https://coveralls.io/github/deepmatterltd/rdfreader)\n[](https://results.pre-commit.ci/latest/github/deepmatterltd/rdfreader/main)\n[](https://github.com/deepmatterltd/rdfreader/actions?workflow=test)\n[](https://github.com/deepmatterltd/rdfreader/blob/master/LICENSE)\n[](https://github.com/python/black)\n[](https://pypi.python.org/pypi/rdfreader/)\n\n## User Guide\n\n### Installation\n\n``` bash\npip install rdfreader\n```\n\n### Basic Usage\n\n``` python\nfrom rdfreader import RDFParser\n\nrdf_file_name = \"reactions.rdf\"\n\nwith open(rdf_file_name, \"r\") as rdf_file:\n\n # create a RDFParser object, this is a generator that yields Reaction objects\n rdfreader = RDFParser(\n rdf_file,\n except_on_invalid_molecule=False, # will return None instead of raising an exception if a molecule is invalid\n except_on_invalid_reaction=False, # will return None instead of raising an exception if a reaction is invalid \n )\n\n for rxn in rdfreader:\n if rxn is None:\n continue # the parser failed to read the reaction, go to the next one\n \n # rxn is a Reaction object, it is several attributes, including:\n print(rxn.smiles) # reaction SMILES string\n print(rxn.properties) # a dictionary of properties extracted from the RXN record\n \n reactants = rxn.reactants # a list of Molecule objects\n products = rxn.products\n solvents = rxn.solvents \n catalysts = rxn.catalysts \n \n # Molecule objects have several attributes, including:\n print(reactants[0].smiles)\n print(reactants[0].properties) # a dictionary of properties extracted from the MOL record (often empty)\n reactants[0].rd_mol # an RDKit molecule object\n```\n\n## Developer Guide\n\nThe project is managed and packaged using [poetry](https://python-poetry.org/docs/#installation).\n\n### Installation\n\n``` bash\ngit clone https://github.com/deepmatterltd/rdfreader\npoetry install # create a virtual environment and install the project dependencies\npre-commit install # install pre-commit hooks, these mostly manage codestyle\n```\n\n### Contributions\n\nContributions are welcome via the [fork and pull request model](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).\n\nBefore you commit changes, ensure these pass the hooks installed by pre-commit. This should be run automatically on each commit if you have run `pre-commit install`, but can be run manually from the terminal with `pre-commit run`.\n\n### Releases\n\nReleases are managed by GitHub releases/workflow. The version number in the pyproject file should ideally be kept up to date to the current release but is ignored by the release workflow.\n\nTo release a new version:\n\n- Update the pyproject.toml version number.\n- Push the changes to GitHub and merge to main via a pull request.\n- Use the github website to create a release. Tag the commit to be released with a version number, e.g. v1.2.3. The tag should be in v*.*.* and match the version number in the pyproject.toml file.\n- When the release is published, a github workflow will run, build a wheel and publish it to PyPI.\n\n### Example Data\n\nYou can find example data in the `test/resources directory`. `spresi-100.rdf` contains 100 example records from SPRESI.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Read the full contents of CTAB .rdf files in python. Captures RXN and MOL record using RDKit and reads additional data fields (including solvents/catalysts/agents).",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://www.deepmatter.io",
"Repository": "https://github.com/deepmatterltd/rdfreader/"
},
"split_keywords": [
"chemistry",
"rdkit",
"rdf",
"rxn",
"mol",
"reaction",
"molecule",
"reader",
"parser",
"deepmatter",
"ctab",
"cheminformatics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7c7e3c25a78c6b84299340ddbc4397dcaa7464773a5f8ae0221e2a0eb38789e2",
"md5": "17afb502d3e38fd39c8964ada6afdeee",
"sha256": "25bfa337c0339b0551f975098e706a23f99cfbb8ff6c3b528e9c991351ac36e7"
},
"downloads": -1,
"filename": "rdfreader-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "17afb502d3e38fd39c8964ada6afdeee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 15719,
"upload_time": "2023-08-03T09:13:45",
"upload_time_iso_8601": "2023-08-03T09:13:45.344580Z",
"url": "https://files.pythonhosted.org/packages/7c/7e/3c25a78c6b84299340ddbc4397dcaa7464773a5f8ae0221e2a0eb38789e2/rdfreader-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "69cdcdb4e57c5346f8470238ebfd4299a18f2943cd6c6ef8b1e632d0a64143b1",
"md5": "71e4f3b39077a8e4b799668456d46051",
"sha256": "4ffec8cb04976a4dfd249d4e1b8d95f6efd2d6a4c8248d9e6a59cced44d14476"
},
"downloads": -1,
"filename": "rdfreader-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "71e4f3b39077a8e4b799668456d46051",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 13258,
"upload_time": "2023-08-03T09:13:46",
"upload_time_iso_8601": "2023-08-03T09:13:46.548396Z",
"url": "https://files.pythonhosted.org/packages/69/cd/cdb4e57c5346f8470238ebfd4299a18f2943cd6c6ef8b1e632d0a64143b1/rdfreader-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-03 09:13:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deepmatterltd",
"github_project": "rdfreader",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "rdfreader"
}
JSON
