Welcome to timeseries-explain documentation!

Contents:

• Quickstart
  • Requirements
  • What is timeseries-explain?
  • What are the objectives of timeseries-explain?
  • Design Principles of timeseries-explain?
  • Install Prerequisites - Linux
  • Generate Documentation
  • Script Utils
  • Navigation
  • Contributing Guidelines
• Installation
  • Git Configuration
  • Backend Requirements
  • Frontend Requirements
  • Backend local development
• Configuration
  • Dashboard Configuration
    • Configuration Options:
    • Sample Configuration
• Troubleshooting Guidelines
  • Backend local development, additional details
    • General workflow
    • Docker Compose Override
    • Backend tests
      • Local tests
      • Test running stack
      • Test Coverage
    • Live development with Python Jupyter Notebooks
    • Migrations
    • Development with Docker Toolbox
    • Development in localhost with a custom domain
    • Development with a custom IP
    • Change the development “domain”
  • Frontend development
    • Removing the frontend
  • Deployment
    • Traefik network
    • Persisting Docker named volumes
      • Adding services with volumes
      • docker-auto-labels
      • (Optionally) adding labels manually
    • Deploy to a Docker Swarm mode cluster
      • Deployment Technical Details
    • Continuous Integration / Continuous Delivery
  • Docker Compose files and env vars
    • The .env file
  • URLs
    • Production URLs
    • Staging URLs
    • Development URLs
    • Development with Docker Toolbox URLs
    • Development with a custom IP URLs
    • Development in localhost with a custom domain URLs
  • Project generation and updating, or re-generating
• Changelog
  • (unreleased)
• Coverage
• Library Stats
• About
• API Reference
  • login
  • users
  • utils
  • items
  • adhesives
  • data_wrangler

Indices and tables

• Index

• Module Index

• Search Page