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.MMFF94Typifier()
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-0.8.0-cp312-abi3-win_amd64.whl (4.8 MB view details)

Uploaded CPython 3.12+Windows x86-64

molcrafts_molrs-0.8.0-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.5 MB view details)

Uploaded CPython 3.12+manylinux: glibc 2.17+ x86-64

molcrafts_molrs-0.8.0-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl (9.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-0.8.0-cp312-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for molcrafts_molrs-0.8.0-cp312-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 07268754c0b61421f523266a1b870c0ee4167ae7cb8bab8f55663a1b83039c58
MD5 45eb9dd8eea90b9b69e9605c4a17b27d
BLAKE2b-256 4f11d168de5b788c55756f5c9b369731b736189c41de877f969f9a9369f41451

See more details on using hashes here.

Provenance

The following attestation bundles were made for molcrafts_molrs-0.8.0-cp312-abi3-win_amd64.whl:

Publisher: publish.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-0.8.0-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for molcrafts_molrs-0.8.0-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 07363c75631506ac62b87dd53e1f11e0ff2d231a727738449f6d41d5e5a0253c
MD5 20d67b813dd162cd1549042e0dde5478
BLAKE2b-256 33a800afa67488ff72c33c556229ee948e02c7612f815791eb63ae8f859454d4

See more details on using hashes here.

Provenance

The following attestation bundles were made for molcrafts_molrs-0.8.0-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: publish.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-0.8.0-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl.

File metadata

File hashes

Hashes for molcrafts_molrs-0.8.0-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm Hash digest
SHA256 3b3c2a2f0117c2b1f1ea6a4c9e46779ecef0bb45062881c3bb78361da9496d11
MD5 0a6b0d0231bb5d848902829cd13d8b61
BLAKE2b-256 81b375051550e2fa6f8a28bf3eb3d1a96e75cc115d0bf243ef9c7ff68fa52de2

See more details on using hashes here.

Provenance

The following attestation bundles were made for molcrafts_molrs-0.8.0-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl:

Publisher: publish.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