Welcome to PyXC: Python Point-to-Point Correlation Library

PyXC is designed to facilitate point-to-point correlation in various types of scientific data. With this library, you can:

• Perform correlations directly within Jupyter Notebooks.

• Utilize a flexible architecture for custom correlation needs.

For a more in-depth introduction, please follow the link below:

• Introduction

Installation

Get started by installing PyXC. Detailed installation guides can be found here:

• PyXC Installation Guide

Tutorials

Learn the basics or dive deep into PyXC’s functionalities with our step-by-step tutorials.

Basic Usage:

• Tutorial 1. Quick Tutorial
• Tutorial 2. Parsing a data
• Tutorial 3. Loading data into the Layer object
• Tutorial 4. Performing queries
• Tutorial 5. Correcting distortions

Advanced Usage:

Note

Subclassing data loaders and transformers is typically note necessary for most use cases. Also, subclassing data loader is not supported at this moment.

If you wish to implement a custom data loader or transformer, please refer to:

• Tutorial 6. Subclassing dataloader object
• Tutorial 7. Subclassing Transformation object.

Contributing

Interested in contributing? Guidelines and information on setting up your development environment can be found here:

• Contribute to this project

API Reference

For a complete list of PyXC’s API, consult the following:

• API Reference

Indices and Tables

• General Index

• Module Index