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.4.0.tar.gz (6.6 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.4.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ursina_proteins-1.4.0.tar.gz
Algorithm Hash digest
SHA256 50d3953353486168a800120179746182bcaf712cf896a75aa65fe2813202cd0c
MD5 ed2aa236b190adf938a9f9043b781997
BLAKE2b-256 ec1b52b4e8fddb37809afc463a4ea07c0e2104855fb6085e274d6608e370de30

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ursina_proteins-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5d308548da3f6c8593c740234b9ff47b9759087d123f90d0423a249d6396b7d8
MD5 60f41c51ea2f763a193208053c630efe
BLAKE2b-256 85c408416376881a9bc450d8104b02444d2e83252dc805cfbe80edcdce2e3aa6

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