baldwicc / OpenEduAnalytics

This project provides open source Education Analytics solutions built on Azure.

Open Education Analytics

Open Education Analytics (OEA) is a fully open-sourced data integration and analytics framework for the education sector, as well as catalogs of assets contributed by customers and partners around the world - for K-12 as well as Higher Education.

The goal is to empower the ecosystem by:

1. making it easy to setup a modern lakehouse in Azure
2. facilitating the sharing of common assets (data pipelines, transformation scripts, dashboards, etc)

To find out more about the growing ecosystem around OEA, including info about partners and customers that are using OEA today, visit our homepage at: openeducationanalytics.org

Setting up OEA

What you need

To setup an environment with OpenEduAnalytics, you'll need:

• an Azure subscription (if you don't have an Azure subscription, you can set up a free subscription here, or check the current list of Azure offers)
• role assignment of "Owner" on the Azure subscription you're using
• make sure your preferred subscription is selected as default
  az account list --query "[].{SubscriptionId:id,IsDefault:isDefault,Name:name,TenantId:tenantId}"
az account set --subscription <SubscriptionId>

Setup

You can setup this fully functional reference architecture (which includes test data sets for basic examples of usage) in 3 steps:

1. Open cloud shell in your Azure subscription (use ctrl+click on the button below to open in a new page)
   
2. Download the OEA framework setup script and framework assets to your Azure clouddrive
   cd clouddrive
wget https://github.com/microsoft/OpenEduAnalytics/releases/download/OEA_framework_v0.6.1/OEA_v0.6.1.zip
unzip ./OEA_v0.6.1.zip
3. Run the setup script like this (substitute "mysuffix" with your preferred suffix, which must be less than 13 characters and can only contain letters and numbers - this will be used as a suffix in the naming of provisioned resources):
   ./OEA_framework_v0.6.1/setup.sh mysuffix
   (for "mysuffix", choose an id or acronym representing your organization - this will be used when naming azure resources that need to be provisioned)

(You can refer to this setup video for a quick walkthrough of this process)

---

Note that OEA is built on mature Azure platform services which provide their own SLA's, but OEA itself is an open-source set of resources that come with no warranties nor SLA's. Each organization utilizing these assets is responsible for adhering to their own data governance practices and ensuring security and privacy of their data. This repo should be considered as a starting point and accelerator for the development of your modern education data estate.

legal info: Legal Notices
info on contributing: Contributing