Skip to main content

Unofficial Python tools for querying NIST Chemistry WebBook pages and extracting molecular-property records

Project description

NistChemPy

Unofficial Python tools for querying NIST Chemistry WebBook pages and extracting molecular-property records.

DOI

Status: usable research package / beta.
NistChemPy is an unofficial Python package for querying NIST Chemistry WebBook pages and extracting selected molecular-property records. It is not affiliated with, maintained by, or endorsed by NIST. Because the Chemistry WebBook does not provide a stable public web API for this package, functionality may depend on the current structure and behavior of the external web service.

NistChemPy automates selected search and data-extraction workflows for the NIST Chemistry WebBook. It currently supports extraction of basic compound metadata, selected spectral records (IR, THz, MS, and UV-Vis), and gas chromatography records where these are available from the corresponding WebBook pages. Additional properties may be reachable through source URLs stored by the package, but direct extraction is intentionally limited to the implemented record types.

For serious scientific use, users should verify retrieved records against the original NIST Chemistry WebBook pages and the primary literature references given there. Package output should not be treated as an official NIST data product, a complete database dump, or a stable production API.

Main features

  1. Search:

    • Search by name, chemical formula, CAS RN, InChI / InChI Key: nistchempy.run_search.

    • Search by structure, including substructural search: nistchempy.run_structural_search.

    • Search over the package-internal table of pre-extracted compound identifiers and metadata: nistchempy.get_all_data. This table is included to support NistChemPy workflows and should not be interpreted as an authoritative, complete, or independently licensed redistribution of the NIST Chemistry WebBook.

  2. Compound info (nistchempy.compound.NistCompound):

    • Object stores parsed properties and corresponding source URLs.

    • Supports extraction of selected records:

      • 2D and 3D atomic coordinates.

      • Spectral data (IR, MS, UV-Vis).

      • Gas chromatography data.

For more details see the CookBook section of the documentation.

Related project: NistChemData

NistChemData is a historical companion repository containing extracted data files and extraction scripts produced with earlier NistChemPy workflows. It is not an official NIST product and is not promoted here as an authoritative, complete, current, or independently licensed redistribution of the NIST Chemistry WebBook.

Users should review the NistChemData data-use notice, original NIST Chemistry WebBook pages, applicable NIST terms, and source references before using those files in scientific, commercial, or redistributed datasets.

Installation

Install NistChemPy using pip:

pip install nistchempy

[!WARNING] Please note that versions starting with 1.0.0 are not backward compatible with the older alpha versions due to significant changes in the code structure. You may need to update your nistchempy-based code or use the older nistchempy versions.

How To

The primary features of NistChemPy, such as search capabilities and compound manipulations, are detailed in the documentation.

Citation

If you use NistChemPy in research, please cite the software using the metadata in CITATION.cff. The Zenodo concept DOI for citing NistChemPy across versions is 10.5281/zenodo.20235917.

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

nistchempy-1.0.6.tar.gz (11.4 MB view details)

Uploaded Source

Built Distribution

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

nistchempy-1.0.6-py3-none-any.whl (11.4 MB view details)

Uploaded Python 3

File details

Details for the file nistchempy-1.0.6.tar.gz.

File metadata

  • Download URL: nistchempy-1.0.6.tar.gz
  • Upload date:
  • Size: 11.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for nistchempy-1.0.6.tar.gz
Algorithm Hash digest
SHA256 5733579ee38769454d41c24dd7d428dff7d501b54cd8ddfc7e87af8363536bcd
MD5 40d820495dc9b0ee549762366012fa1c
BLAKE2b-256 f005620ab7cf8430eb4bb90a626c6970e48176609b6cd75c7723732283f5489c

See more details on using hashes here.

File details

Details for the file nistchempy-1.0.6-py3-none-any.whl.

File metadata

  • Download URL: nistchempy-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 11.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for nistchempy-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 97dedb3cb21e50b97cf8374b319c89688fe8e9b389515e9fda985a91aa7954f9
MD5 1f9756ac830b5ae7dc8c07f3490fabc4
BLAKE2b-256 33562c8581fa26893a46255cbd706d3497bb9cb6f4689d706b034b4274c11b3c

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