CausalIQ Core¶
Welcome¶
Welcome to the documentation for the CausalIQ Core — part of the CausalIQ ecosystem for intelligent causal discovery.
CausalIQ Core provides functionality required by several CausalIQ projects. It is not envisaged that it will be used or called directly itself, nor can it be directly used in CausalIQ Workflows.
Overview¶
CausalIQ Core provides the following common functionality required by several user-facing CausalIQ packages in the following areas:
- graph: support for general graphs, PDAGs and CPDAGs used in causal discovery;
- bn: support for Bayesian Networks (BNs);
- io: filesystem io and format conversion, particularly relating to standard formats for graphs (.graphml, .dsc etc) and BNs (.xdsl)
- utils: utility enums, functions and classes, relating to random numbers, mathematical functions, path handling etc.
This site provides detailed documentation, including: development roadmap, architectural vision, design notes, and API reference for contributors. Since this is not a "user-facing" capability a user guide is not provided.
Quickstart & Installation¶
For a quickstart guide and installation instructions, see the README on GitHub.
Documentation Contents¶
- Development Roadmap: roadmap of upcoming features
- Architecture: overall architecture and design notes
- API Reference: complete reference for Python code
- Development Guidelines: CausalIQ guidelines for developers
- Changelog
- License
Support & Community¶
- GitHub Issues: Report bugs or request features.
- GitHub Discussions: Ask questions and join the community.
Tip:
Use the navigation sidebar to explore the documentation.
For the latest code and releases, visit the causaliq-core GitHub repository.
Supported Python Versions: 3.9, 3.10, 3.11, 3.12
Default Python Version: 3.11