circumplex

[]

circumplex is a Python package for analyzing and visualizing circumplex data. It provides a set of tools for analyzing and visualizing circumplex data, following the Structural Summary Method. This project is a Python implementation based on the R circumplex package. Our goal is to provide a similar functionality and experience for Python users.

[!IMPORTANT] Massive update: the upcoming 0.3 release is a substantial rewrite of circumplex. Highlights include a modular package architecture, expanded SSM and plotting workflows, built-in instrument and tidying utilities, stronger regression coverage against the R package, and a refreshed docs/CI/release toolchain. See the changelog for release notes.

[!WARNING] This project is still under development. We're working hard to make it as good as possible, but there may be bugs or missing features. If you find any issues, please let us know by submitting an issue on Github.

Getting Started

To get started with circumplex, install it from PyPI:

pip install circumplex

Documentation

This documentation is designed to help you understand and use circumplex effectively. It's divided into several sections:

• Docs Site: The published documentation is available at drandrewmitchell.com/circumplex.
• Tutorials: Practical examples showing how to use our project in real-world scenarios.
• API Reference: Detailed information about our project's API.
• Changelog: Release highlights and migration context for the upcoming version.
• Contribute: Information on how you can contribute to our project.

Contributing

We welcome contributions from the community. If you're interested in contributing, please get in touch or submit an issue on Github.

License

This project is licensed under the GNU GPLv3 License. For more information, please see the LICENSE file.

Project layout

    .github/workflows/
        docs.yml
        linting.yml
        python-package.yml
    CHANGELOG.md
    docs/
        changelog.md
        index.md
        api/
        tutorials/
    examples/
    src/circumplex/
        analysis/
        core/
        instruments/
        visualization/
    pyproject.toml
    uv.lock
    zensical.toml