System Environment Documentation

Configuration Overview

The environment configuration detects the operating system and sets a default root directory. It also configures multiple folders for system files, logs, databases, temporary data, user documents, and output.

Default Root Directory

The default root directory is set depending on the OS:

• win32: On Windows, the "Roaming" directory for application data is located at %APPDATA%, typically C:\Users\<username>\AppData\Roaming\paramus\Copilot
• darwin: On macOS, application-specific data is often found within the ~/Library/Application Support/paramus/Copilot directory, or sometimes within ~/Library/Containers/<application_name>/Data/paramus/Copilot

If the PARAMUS_ROOT environment variable is not defined, the default root for the current OS is used.

Generated Directories

The following directory structure is created based on the root folder:

/root_folder/               # Main root directory
│── system/                 # System-related files
│   │── settings.json       # Configuration file
│   │── license.key         # License information
│   │── logs/               # Logs directory
│       ├── program.log     # Application logs
│── databases/              # Databases directory
│       ├── training.db       # Database for LLM fine tuning
│       ├── knowledgegraph.db # Knowledge graph database
│── tmp/                    # Temporary data
│── backups/                # Backup storage
│── user/                   # User-related files
│   │── content/            # User main work files MOST IMPORTANT
│   │── output/             # Processed Word files