Metadata-Version: 2.4
Name: poseigen_seaside
Version: 0.1.3
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

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

## Features

Seaside is organized into three modules:

- Basics: general-purpose utilities for array handling, transformations, rolling-window operations, and data helpers.
- Metrics: evaluation functions for model and distribution-based scoring.
- Visuals: plotting utilities for line plots, heatmaps, and scatter-plus-histogram visualizations.

## Installation

Install from PyPI:

```bash
pip install poseigen_seaside
```

For local development, install from source using your preferred editable-install workflow.

## Usage

Import from the package:

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

```

## Project Status

Seaside is in active development and is intended to be the shared base package for the Poseigen ecosystem.

## License

This project is released under the MIT License.

