Installation Guide

Get up and running with Academic Workflow Suite in minutes.

Quick Start

The fastest way to install Academic Workflow Suite on your system:

# Using Homebrew (recommended)
brew install academic-workflow-suite

# Or download the installer
curl -sSL https://install.academic-workflow.org | bash
# Using the install script
curl -sSL https://install.academic-workflow.org | bash

# Or using package managers:
# Debian/Ubuntu
sudo apt install academic-workflow-suite

# Fedora/RHEL
sudo dnf install academic-workflow-suite

# Arch Linux
yay -S academic-workflow-suite
# Using Windows Package Manager
winget install AcademicWorkflowSuite

# Or using Chocolatey
choco install academic-workflow-suite

# Or download the MSI installer from the download page

System Requirements

Minimum Requirements

  • OS: macOS 11+, Windows 10+, or Linux (kernel 4.15+)
  • CPU: Dual-core processor (x86_64 or ARM64)
  • RAM: 4 GB
  • Storage: 500 MB available space
  • Optional: Internet connection for LMS sync

Recommended Requirements

  • OS: Latest stable version
  • CPU: Quad-core processor or better
  • RAM: 8 GB or more
  • Storage: 2 GB available space (for AI models)
  • GPU: Optional, for faster AI processing

About AI Models

The base installation includes lightweight AI models (~200MB). For enhanced feedback quality, you can optionally download advanced models (up to 2GB) during or after installation.

Detailed Installation Steps

1

Download the Installer

Visit the download page and select the installer for your platform:

  • macOS: AWS-macOS-v1.0.0.dmg (Apple Silicon or Intel)
  • Windows: AWS-Windows-v1.0.0.msi
  • Linux: AWS-Linux-v1.0.0.AppImage or distribution-specific packages
2

Verify the Download (Optional but Recommended)

Verify the integrity of your download using checksums:

# macOS/Linux
sha256sum AWS-*.dmg
# Compare with published checksum

# Windows (PowerShell)
Get-FileHash AWS-*.msi -Algorithm SHA256
3

Run the Installer

  • macOS: Open the DMG file and drag Academic Workflow Suite to Applications
  • Windows: Double-click the MSI file and follow the installation wizard
  • Linux: Make the AppImage executable and run it, or use your package manager
4

Initial Configuration

Launch Academic Workflow Suite and complete the setup wizard:

  1. Choose your preferred language and region
  2. Configure data storage location (default: ~/AcademicWorkflow)
  3. Enable or disable AI features and select models
  4. Set up encryption passphrase (required for data security)
  5. Optionally configure LMS integration
5

Verify Installation

Confirm everything is working correctly:

# Check version
aws --version

# Run system check
aws doctor

# Expected output:
# ✓ All systems operational
# ✓ AI models loaded
# ✓ Storage accessible
# ✓ No issues detected

Video Tutorial

Installation Walkthrough

5 minute video showing the complete installation process

Video coming soon! Subscribe to our blog for updates.

LMS Integration Setup

Connect Academic Workflow Suite with your Learning Management System:

  1. Log into your OU account and navigate to Settings
  2. Generate an API token under "Integrations"
  3. In AWS, go to Settings → Integrations → Add LMS
  4. Select "Open University" and paste your API token
  5. Click "Test Connection" to verify
  1. Access your Moodle site as an administrator
  2. Navigate to Site Administration → Plugins → Web Services
  3. Enable web services and create a token for your account
  4. In AWS, select "Moodle" integration and enter your site URL
  5. Paste the token and authorize the connection
  1. Log into Canvas and click on Account → Settings
  2. Scroll to "Approved Integrations" and click "+ New Access Token"
  3. Give it a purpose (e.g., "Academic Workflow Suite") and generate
  4. Copy the token (shown only once!)
  5. In AWS, add Canvas integration with your institution's Canvas URL and token

Troubleshooting

Installation fails on macOS

Issue: "App cannot be opened because it is from an unidentified developer"

Solution:

  1. Right-click the app and select "Open"
  2. Click "Open" in the security dialog
  3. Alternatively: System Preferences → Security & Privacy → Allow app

AI models not loading

Issue: Error message "Failed to load AI models"

Solution:

  1. Ensure you have at least 500MB free disk space
  2. Run aws models download to re-download
  3. Check firewall isn't blocking downloads
  4. Try manual model installation from downloads

LMS connection fails

Issue: Cannot connect to Learning Management System

Solution:

  1. Verify your API token is still valid
  2. Check the LMS URL is correct (including https://)
  3. Ensure your network allows connections to the LMS
  4. Try regenerating the API token in your LMS

Permission errors on Linux

Issue: "Permission denied" when running commands

Solution:

  1. Make the binary executable: chmod +x academic-workflow-suite
  2. Ensure your user has write access to the data directory
  3. Don't run as root unless necessary

Still Having Issues?

We're here to help! Check these resources:

Next Steps

Read the Documentation

Learn how to use all features effectively

Explore Features

Discover what Academic Workflow Suite can do

Read Tutorials

Follow step-by-step guides and best practices