Metadata-Version: 2.4
Name: poseigen_seaside
Version: 1.0.1
Summary: Core utilities for the Poseigen package family
Author-email: Husam Abdulnabi <husam.abdulnabi@gmail.com>
Maintainer-email: Husam Abdulnabi <husam.abdulnabi@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/husam94/poseigen_seaside
Project-URL: Repository, https://github.com/husam94/poseigen_seaside
Project-URL: Issues, https://github.com/husam94/poseigen_seaside/issues
Keywords: poseigen,bioinformatics,machine-learning,utilities
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: denseweight
Requires-Dist: tqdm
Requires-Dist: torch
Requires-Dist: torch-betainc
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Dynamic: license-file

# Seaside

[![PyPI version](https://img.shields.io/pypi/v/poseigen_seaside)](https://pypi.org/project/poseigen_seaside/)
[![Python versions](https://img.shields.io/pypi/pyversions/poseigen_seaside)](https://pypi.org/project/poseigen_seaside/)
[![License](https://img.shields.io/pypi/l/poseigen_seaside)](https://pypi.org/project/poseigen_seaside/)

Seaside is the core utility package in the Poseigen ecosystem. It provides shared helpers for numerical workflows, metrics, and plotting, and serves as the foundation for other Poseigen packages.

Part of the [Poseigen ecosystem](https://github.com/Husam94/poseigen).

## Installation

Requires Python 3.12 or newer. Install from PyPI:

```bash
python -m pip install poseigen_seaside
```

## Package

Seaside is organized into three modules:

- **`basics`** provides general-purpose utilities for array handling, transformations, rolling-window operations, and data helpers.
- **`metrics`** provides evaluation functions for model and distribution-based scoring.
- **`visuals`** provides plotting utilities for line plots, heatmaps, and scatter-plus-histogram visualizations.

## Usage

Import the modules you need:

```python
import poseigen_seaside.basics as se
import poseigen_seaside.metrics as mex
import poseigen_seaside.visuals as viz
```
