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.2.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.2-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ursina_proteins-1.5.2.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.2.tar.gz
Algorithm Hash digest
SHA256 773645d5cabc1410b98e000bd3d65c28799f7f1742e08097cb03a02b18c615de
MD5 f897487a4e73ab0edd27eed32967dd10
BLAKE2b-256 725e4fb0b6451437153be52112f47a9018b8c5c3750608f2a87a6e8515a83aeb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ursina_proteins-1.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ea15ba3a8612a501c5dad3c70ab100e5c28378fd4e8ac97dab21c42070238cff
MD5 a503c8ec586039cf297cb6ed41d9fcfe
BLAKE2b-256 e3b08bd171a798b6bf7dd511fae319d3804e421ee1bd728eb0056d90b351dc67

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