ursina-proteins 0.1.0

No project description provided

Ursina Proteins

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

Installation

To install the library locally, clone the repo down and install dependencies with Poetry.

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

# Install with poetry
poetry install

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).

poetry run python src/demo.py

Contributions

Contributions are welcome. Please use conventional commits and enable pre-commit hooks.

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