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.dev202606100625-cp312-abi3-win_amd64.whl (3.9 MB view details)

Uploaded CPython 3.12+Windows x86-64

molcrafts_molrs_nightly-0.0.18.dev202606100625-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.dev202606100625-cp312-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for molcrafts_molrs_nightly-0.0.18.dev202606100625-cp312-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 fc87a196755462b12cfd531e8070f2f813d0ba0e658582aea4957e53be3ada49
MD5 2e767d3a575a5e68e5e374eead7a010b
BLAKE2b-256 3120a792802c9ba22438e2899b3341eab2a9bc75054baea2416d7e25ecf7f94b

See more details on using hashes here.

Provenance

The following attestation bundles were made for molcrafts_molrs_nightly-0.0.18.dev202606100625-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.dev202606100625-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for molcrafts_molrs_nightly-0.0.18.dev202606100625-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 92138726e053a13bf3484bc01b46058ea6dd1ee9cd5567c9e7c35db119e299eb
MD5 97d808f8a4625f6e627ee512c1d1feff
BLAKE2b-256 c50b4bcce7692c180285e15566bdda3200c88d51383f60f75eb6d9ce17fc82a1

See more details on using hashes here.

Provenance

The following attestation bundles were made for molcrafts_molrs_nightly-0.0.18.dev202606100625-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.dev202606100625-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.dev202606100625-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm Hash digest
SHA256 490e19d6594a0f931c79666c8baf7bf5b5f680000141aa0d7f0ac7b664fdbf2e
MD5 a7e0230d5c4cce7f6af5ff1cb3d68f89
BLAKE2b-256 e5e67e1838dcc73a67ede9beb4767caa23c1d1875e6015a81e3430d45a086a2c

See more details on using hashes here.

Provenance

The following attestation bundles were made for molcrafts_molrs_nightly-0.0.18.dev202606100625-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