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.1.4.dev202606190947-cp312-abi3-win_amd64.whl (4.0 MB view details)

Uploaded CPython 3.12+Windows x86-64

molcrafts_molrs_nightly-0.1.4.dev202606190947-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.8 MB view details)

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

molcrafts_molrs_nightly-0.1.4.dev202606190947-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl (8.6 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.1.4.dev202606190947-cp312-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for molcrafts_molrs_nightly-0.1.4.dev202606190947-cp312-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 d287a213a9f1eed259a4721123dab86b8e1c16213ea80fa08655f113eda5efd9
MD5 fe7f7f16dbe937bfe54dad119253efbc
BLAKE2b-256 91cee02790be2729fba386d0298c3412fde3cf60e60c08d59a6ec495a582941c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for molcrafts_molrs_nightly-0.1.4.dev202606190947-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 1d295ac26eb7c1454e3ddcc6a1b31de57aef9456160933fb50b8f09309ccc68e
MD5 4d13cd85007b20fb1d9485a988d1c287
BLAKE2b-256 59f1cdcc2f3d8a61ab4d2119162ea7abf8223f13b31dd2fa84188886927f8cc5

See more details on using hashes here.

Provenance

The following attestation bundles were made for molcrafts_molrs_nightly-0.1.4.dev202606190947-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.1.4.dev202606190947-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.1.4.dev202606190947-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm Hash digest
SHA256 e84ac00d45beef4e633a752c1d68450388fed7670626b36635e28c23807a9af7
MD5 39dfd9775f549ba265be08fefa4d3919
BLAKE2b-256 2eba0db2b5c770c78434dfcab292b0f84824e861aac5cb444f7b0d2c728dd872

See more details on using hashes here.

Provenance

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