Skip to content

microsoft/OpenEduAnalytics

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)
    Launch Cloud Shell
  2. Download the OEA framework setup script and framework assets to your Azure clouddrive
    cd clouddrive
    wget https://github.com/microsoft/OpenEduAnalytics/releases/download/v0.8/OEA_v0.8.zip
    unzip ./OEA_v0.8.zip
  3. Run the setup script like this (substitute "mysuffix" with your preferred suffix representing your org, 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_v0.8/setup.sh -o mysuffix

(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.

Licenses

All code is licensed under the MIT License
All documentation is licensed under Creative Commons

Contributing

This project welcomes contributions and suggestions...

Microsoft Open Source Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct.

Resources:

Security

Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include Microsoft, Azure, DotNet, AspNet, Xamarin, and our GitHub organizations.

If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's definition of a security vulnerability, please report it to us as described below.

Reporting Security Issues

Legal Notices

Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the Creative Commons Attribution 4.0 International Public License, see the LICENSE file, and grant you a license to any code in the repository under the MIT License, see the LICENSE-CODE file.

Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.

Privacy information can be found at https://privacy.microsoft.com/en-us/

Microsoft and any contributors reserve all other rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise.