Merge pull request #5 from OKN-CollabNext/institution-nodes

Use real data from OpenAlex for Institutions

.gitignore

@@ -6,4 +6,7 @@ __pycache__/
 .venv/
 
 # Ignore vscode settings
-.vscode/
+.vscode/
+
+# Ignore dot env files
+.env

README.md

@@ -45,6 +45,14 @@ You can then install project dependencies as follows:
 poetry install
 ```
 
+You need a `.env` file to store secrets as follows:
+
+```
+OPENALEX_EMAIL=mailto@example.com
+```
+
+The OPENALEX_EMAIL secret is used to [speed up calls](https://docs.openalex.org/how-to-use-the-api/api-overview) to the OpenAlex REST API.
+
 ## Running
 
 This project uses [Observable Framework](https://observablehq.com/framework/). You can run the site locally as follows

observable/docs/data/graph.json.py

@@ -0,0 +1,36 @@
+import json
+import os
+
+import pyalex
+from dotenv import load_dotenv
+from pyalex import Institutions
+
+# Load Secrets
+load_dotenv()
+
+# Initialize the pyalex client
+pyalex.config.email = os.getenv("OPENALEX_EMAIL")
+
+# Get 5 random institutions
+institutions = [Institutions().random() for _ in range(5)]
+
+# Gather associated institutions
+associated_institutions = [
+    y for x in institutions for y in x["associated_institutions"]
+]
+
+# Combine all institutions
+all_institutions = [*institutions, *associated_institutions]
+
+# Create nodes
+nodes = [{"id": x["id"], "label": x["display_name"]} for x in all_institutions]
+
+# Create associated institution edges
+edges = [
+    {"id": x["id"], "start": x["id"], "end": y["id"], "label": "ASSOCIATED"}
+    for x in institutions
+    for y in x["associated_institutions"]
+]
+
+
+print(json.dumps({"nodes": nodes, "edges": edges}))

observable/docs/index.md

@@ -15,8 +15,11 @@ const query = view(Inputs.text());
 ### Your Peer Network
 
 ```js
-const nodes = FileAttachment("data/nodes.json").json();
-const edges = FileAttachment("data/edges.json").json();
+const graph = FileAttachment("data/graph.json").json();
+```
+
+```js
+const { nodes, edges } = graph;
 ```
 
 <script src="https://unpkg.com/@memgraph/orb/dist/browser/orb.min.js"></script>

pyproject.toml

@@ -11,6 +11,8 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.11"
+pyalex = "^0.14"
+python-dotenv = "^1.0.1"
 
 
 [tool.poetry.group.dev.dependencies]