Skip to main content

A Python package for rendering protein structures of PDB format in 3D using Ursina

Project description

Ursina Proteins

Python Version from PEP 621 TOML uv Ruff Code-quality CI pre-commit Conventional Commits License: MIT

A Python package for rendering protein structures in 3D using Ursina, as featured in Ursina's sample projects.

Example proteins

Installation

The package is published on PyPI, and can be installed with pip install ursina-proteins. You can also clone the repo down and install dependencies with uv.

# Clone the repo
git clone https://github.com/HarrisonTCodes/ursina-proteins.git
cd ursina_proteins

# Install dependencies with uv
uv sync

Usage

You can render proteins from files in the (default) PDB format, or the mmCIF/PDBx format (by passing legacy_pdb = False in the Protein class constructor). Many protein files can be found at the RCSB Protein Data Bank. You can use the library in an existing Ursina project by importing the Protein class and creating an instance from a protein file.

from ursina_proteins.protein import Protein

Protein("/path/to/file.pdb")

You can also test the library out by running demo.py. This script renders a simple scene with an example protein (insulin).

uv run src/demo.py

Contributions

Contributions are welcome. Please enable pre-commit hooks to catch and fix formatting/linting issues locally before raising a PR.

# Enable pre-commit hooks
uv run pre-commit install

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

ursina_proteins-1.5.3.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

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

ursina_proteins-1.5.3-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file ursina_proteins-1.5.3.tar.gz.

File metadata

  • Download URL: ursina_proteins-1.5.3.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.8

File hashes

Hashes for ursina_proteins-1.5.3.tar.gz
Algorithm Hash digest
SHA256 1bdf15467bda120ee2fbdca7af1a76a69d8534e1b9f8d6349c7ae07a094ae981
MD5 6e7e3bc6371db352ef9874bceb288c74
BLAKE2b-256 c366a346edc1b53f6bbf525fe6e43bf3ec3d12cbf99b0a7065d9f95f4d71bc79

See more details on using hashes here.

File details

Details for the file ursina_proteins-1.5.3-py3-none-any.whl.

File metadata

File hashes

Hashes for ursina_proteins-1.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e2f2e8b4d1c2aeeb9076e792b17ead1d0bb50e90ee8ce1993f92266633eccd59
MD5 1df159f9a6b7d557dc39d4308626b940
BLAKE2b-256 8877203761bdf274919e25d6636585fe4efcf28a6fb6193d891cbfc498b7dc69

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