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 Pre-Commit Check pre-commit Conventional Commits License: MIT

A Python package for rendering protein structures of PDB format 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 use the library in an existing Ursina project by importing the Protein class and creating an instance from a PDB file. You can render any proteins in the PDB file format, and can find many available for download at the RCSB Protein Data Bank.

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.1.1.tar.gz (6.3 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.1.1-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ursina_proteins-1.1.1.tar.gz
Algorithm Hash digest
SHA256 bb1fad5e4a1a9fdfb31335e422ff0980163406750385a5e157462b918867e129
MD5 1a78c462d5e88def2222772977996330
BLAKE2b-256 db090e6a1a1795e76f36fc9804bda56d68ccb0343ae29eb7f606a017a435e01e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ursina_proteins-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1051503b9ff8c23a99c1cd1ad501ba859d814a21311c183cc2bec57837974224
MD5 d8799fe7b1a3303575624e7ce396c76c
BLAKE2b-256 5794563a88fa89e503424b5d726a20e308458863c3d14eefb1a039b0454fc0b7

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