Skip to main content

Python bindings for molrs molecular simulation library

Project description

molcrafts-molrs

PyPI

Python bindings for the molrs molecular modeling toolkit.

This package is the first public preview of the Python API. Install with pip install molcrafts-molrs and import it as molrs.

Full documentation lives at https://molcrafts.github.io/molrs/. The Python API reference is rendered at https://molcrafts.github.io/molrs/reference/python/.

Install

pip install molcrafts-molrs

Quick start

import numpy as np
import molrs

# Parse SMILES and generate 3D coordinates
ir = molrs.parse_smiles("CCO")
mol = ir.to_atomistic()
result = molrs.generate_3d(mol, molrs.EmbedOptions(speed="fast", seed=42))
frame = result.mol.to_frame()

# Build a system from scratch
frame = molrs.Frame()
atoms = molrs.Block()
atoms.insert("x", np.array([0.0, 0.96, -0.24], dtype=np.float64))
atoms.insert("y", np.array([0.0, 0.0, 0.93], dtype=np.float64))
atoms.insert("z", np.zeros(3, dtype=np.float64))
atoms.insert("element", ["O", "H", "H"])
frame["atoms"] = atoms

Support

  • Python 3.9+
  • pip install molcrafts-molrs
  • import molrs
  • Offline API help is available with help(molrs.Frame) and related symbols

API

Data model

  • Frame — dict-like container of named Blocks + optional Box
  • Block — column store backed by numpy arrays
  • Box — simulation box with periodic boundaries

I/O

  • molrs.read_pdb(path) / molrs.read_xyz(path)Frame
  • molrs.parse_smiles(smiles)SmilesIR.to_frame()

Neighbor search and analysis

nq = molrs.NeighborQuery(box, positions, cutoff=5.0)
nlist = nq.query_self()

from molrs.compute.density import RDF
rdf = RDF(100, 5.0)
result = rdf.compute(frame, nlist)

Force field

typifier = molrs.MMFFTypifier()
potentials = typifier.build(atomistic)

Development

maturin build
pip install target/wheels/*.whl
pytest -q
Component Version
Python 3.9+
PyO3 Managed by molrs-python/Cargo.toml
maturin 1.x

License

BSD-3-Clause

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

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

molcrafts_molrs_nightly-0.0.18.dev202606100609-cp312-abi3-win_amd64.whl (3.9 MB view details)

Uploaded CPython 3.12+Windows x86-64

molcrafts_molrs_nightly-0.0.18.dev202606100609-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl (8.8 MB view details)

Uploaded CPython 3.12+macOS 10.12+ universal2 (ARM64, x86-64)macOS 10.12+ x86-64macOS 11.0+ ARM64

File details

Details for the file molcrafts_molrs_nightly-0.0.18.dev202606100609-cp312-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for molcrafts_molrs_nightly-0.0.18.dev202606100609-cp312-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 2995469ea7e4c10235d0d36b8c3006834fc1d4afe32783ded266c951db332573
MD5 96430d97ab37c28fd45c99c82c89796d
BLAKE2b-256 2333f8b81a06705f341ccf10c16ad079f41dd1b8c6589e023b7e4c27e2c89f76

See more details on using hashes here.

Provenance

The following attestation bundles were made for molcrafts_molrs_nightly-0.0.18.dev202606100609-cp312-abi3-win_amd64.whl:

Publisher: nightly.yml on MolCrafts/molrs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file molcrafts_molrs_nightly-0.0.18.dev202606100609-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for molcrafts_molrs_nightly-0.0.18.dev202606100609-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4575e3b50cc9d99e55e0918f45338b14d84fe584dd17a02a4f92640d84499794
MD5 9d988ea954d5965b38872ac72d967052
BLAKE2b-256 c3ac05738923ad09865dcca83caebf956e2844a85cc8f892f3964de919db09c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for molcrafts_molrs_nightly-0.0.18.dev202606100609-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: nightly.yml on MolCrafts/molrs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file molcrafts_molrs_nightly-0.0.18.dev202606100609-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl.

File metadata

File hashes

Hashes for molcrafts_molrs_nightly-0.0.18.dev202606100609-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm Hash digest
SHA256 3430fc7f952a58e7fbad12594c5fa7bfee47ad36e1acaee485a30baaa9dd4c69
MD5 3a43489942937549fc8cbff1f8531323
BLAKE2b-256 e08b7a6f8609a842a2524ba753e537ffa2f4f687c4cf5ffdfbc08f04e95db3a0

See more details on using hashes here.

Provenance

The following attestation bundles were made for molcrafts_molrs_nightly-0.0.18.dev202606100609-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl:

Publisher: nightly.yml on MolCrafts/molrs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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