OpenHEXA Documentation

Complete guide to the open-source data integration platform for public health projects

Welcome to OpenHEXA¶

OpenHEXA is an open-source data integration platform developed by Bluesquare to facilitate data integration and analysis workflows, particularly in the context of public health projects.

This documentation provides comprehensive guides for using OpenHEXA effectively, from basic navigation to advanced pipeline development.

Documentation overview¶

📚 User Manual¶

This user manual covers all aspects of using OpenHEXA:

👤

Account Management

Manage your profile, security settings, and personal preferences.

🧭

Navigation

Learn to navigate between organizations, workspaces, and find resources quickly.

🏢

Workspaces

Create and manage collaborative project environments for your team.

📁

File Management

Upload, organize, and share files through the shared filesystem.

🗄️

Database

Work with PostgreSQL databases for structured data storage and analysis.

📊

Datasets

Manage and version your datasets for reproducible analysis.

🔗

Connections

Connect to external data sources and APIs for data integration.

⚡

Pipelines

Create, run, and schedule complex data workflows and ETL processes.

📓

Notebooks

Use Jupyter notebooks for interactive data exploration and analysis.

Getting started with OpenHEXA¶

🚀 For new users¶

If you're new to OpenHEXA, follow this learning path:

Account Management - Set up your profile and security settings
Navigation - Learn to navigate the platform effectively
Workspaces - Create your first workspace and understand the environment
File Management - Upload and organize your data files
Notebooks - Start exploring data with Jupyter notebooks

🛠️ For developers¶

If you're planning to develop pipelines or work with the API:

Writing OpenHEXA Pipelines - Create custom data workflows
Using the OpenHEXA CLI - Command-line interface
Using the OpenHEXA SDK - Python development kit
Using the OpenHEXA Toolbox - Development utilities
Using Notebooks in OpenHEXA - Advanced notebook usage

👥 For administrators¶

If you're managing teams and organizations:

Administration - Manage organizations, workspaces, and users
Workspaces - Configure workspace settings and permissions

🔧 Installation and administration¶

Installation Instructions - Set up your OpenHEXA instance
Localhosting Installation Instructions - Set up your OpenHEXA instance locally
Technical Architecture - System design and components

🔍 Need help?¶

GitHub Discussions: Community Q&A - Ask questions and share knowledge
GitHub Issues: Report bugs and request features
Documentation: You're here! 📚 - Comprehensive guides and references

🔗 External resources¶

GitHub Repository: BLSQ/openhexa - Source code and development
PyPI Package: openhexa - Python SDK and tools
Bluesquare: Company website - Learn more about the developers

Ready to transform your data into insights?

Join the growing community of public health organizations using OpenHEXA for their data integration needs.

Visit www.openhexa.com

OpenHEXA is developed with ❤️ by Bluesquare for the global public health community.