Documentation Overview
Welcome to ecoKI's documentation portal. Below you'll find a guide to all documentation resources and their locations.
Implementation
Success stories and efficiency scenarios
Installation Documentation
- Main README in GitLab repository root: Setup instructions and prerequisites
- Step-by-step installation guide for ecoKI Python module
- System requirements and configuration guidelines
Building Blocks Documentation
- Component-specific README files in GitLab folders
- Overview descriptions in Dashboard's building blocks section
- Technical specifications in API documentation
Pipeline Documentation
- Configuration details in settings.json files
- Pipeline descriptions in Dashboard's pipeline pool
- Implementation examples in Success Stories section
Implementation Examples
- Success Stories: Real-world implementation cases
- Energy Efficiency Scenarios: Detailed use cases and results
- Best practices and optimization guidelines
Guidelines and FAQs
- Comprehensive FAQs section covering IT security, data modeling, pipelines, and building blocks
- Detailed answers to common questions about database, data connections, and implementation
- Best practices and usage guidelines
Technical Documentation
API Documentation
Complete API reference generated with Sphinx, containing detailed documentation of all modules, classes, and functions.
View API Documentation