From 4ebbabde98a5e6ab85d0462e91e3db22b68bd938 Mon Sep 17 00:00:00 2001
From: mjwen <wenxx151@gmail.com>
Date: Mon, 3 Jul 2023 16:34:44 -0500
Subject: [PATCH] Add colab notebook

---
 README.md                     |  7 ++++--
 notebooks/predict_colab.ipynb | 41 +++++++++++++++++++++++++++++++++++
 2 files changed, 46 insertions(+), 2 deletions(-)
 create mode 100644 notebooks/predict_colab.ipynb

diff --git a/README.md b/README.md
index 323e08a..fe25e63 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,16 @@
 # matten
 
-This repo contains the Materials Tensor (MatTen) for predicting tensorial
+This repo contains the Materials Tensor (MatTen) model for predicting tensorial
 properties of crystals such as the elasticity tensor.
 
+MatTen is an equivariant graph neural network built using [e3nn](https://github.com/e3nn/e3nn).
+
 
 ## Install
 
 ## Use pretrained model
 
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/wengroup/matten/blob/main/notebooks/predict_colab.ipynb)
 
-## Data
 
+## Data
diff --git a/notebooks/predict_colab.ipynb b/notebooks/predict_colab.ipynb
new file mode 100644
index 0000000..42919c5
--- /dev/null
+++ b/notebooks/predict_colab.ipynb
@@ -0,0 +1,41 @@
+{
+  "nbformat": 4,
+  "nbformat_minor": 0,
+  "metadata": {
+    "colab": {
+      "provenance": []
+    },
+    "kernelspec": {
+      "name": "python3",
+      "display_name": "Python 3"
+    },
+    "language_info": {
+      "name": "python"
+    }
+  },
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "source": [
+        "# matten\n",
+        "\n",
+        "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/wengroup/matten/blob/main/notebooks/predict_colab.ipynb)\n",
+        "\n",
+        "\n",
+        "[MatTen](https://github.com/wengroup/matten) is an equivariant graph neural network model for the prediction of tensorial properties of materials."
+      ],
+      "metadata": {
+        "id": "L4MnRfEaqlXB"
+      }
+    },
+    {
+      "cell_type": "code",
+      "source": [],
+      "metadata": {
+        "id": "vhxEz8zJqTOR"
+      },
+      "execution_count": null,
+      "outputs": []
+    }
+  ]
+}