Installation Guide

This guide will help you install Custom Panel and its dependencies.

Prerequisites

• Python 3.10+ - Custom Panel requires Python 3.10 or later
• Poetry - Recommended package manager for Python projects
• Git - For cloning the repository

Installation Methods

Using Poetry (Recommended)

First, clone the repository:

git clone https://github.com/berntpopp/custom-panel.git
cd custom-panel

Install with Poetry:

poetry install
poetry shell

Using pip

# Install in development mode (after cloning)
pip install -e .

From PyPI (when published)

pip install custom-panel

Verify Installation

Check that the installation was successful:

custom-panel --help

You should see the help message with available commands.

Configuration Check

Verify your configuration is valid:

custom-panel config-check

Next Steps

• Running the Pipeline - Learn basic usage
• Configuration - Customize data sources and scoring
• COSMIC Setup - Configure COSMIC access (optional)
• OMIM Setup - Configure OMIM access (optional)

Troubleshooting

Common Issues

ImportError: Ensure you're using Python 3.10+ and all dependencies are installed.

Permission errors: Make sure you have write permissions to the output directory.

API timeouts: Check your internet connection and API access credentials.

Getting Help

If you encounter issues:

1. Check the GitHub Issues
2. Review the configuration documentation
3. Create a new issue with detailed error messages