Skip to content

Commit a0d70c7

Browse files
nikk186nikk186
authored
SciLake: README ack, CITATION.cff, .zenodo.json (#23)
* docs: README intro, Citation pointer, SciLake acknowledgement * chore: add CITATION.cff * chore: add .zenodo.json for Zenodo–GitHub integration
1 parent c7629b5 commit a0d70c7

3 files changed

Lines changed: 132 additions & 1 deletion

File tree

‎.zenodo.json‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
{
2+
"title": "GraphAlg: An Embeddable Language for Writing Graph Algorithms in Linear Algebra",
3+
"description": "<p>GraphAlg is a domain-specific language for graph algorithms based on linear algebra, designed to be embedded in databases. It compiles via a MATLANG-based core language to relational algebra, and is integrated into AvantGraph through the Cypher <code>WITH ALGORITHM</code> clause. The repository includes the compiler, language specification, Codemirror language support, an interactive WebAssembly playground, and a tutorial.</p>",
4+
"upload_type": "software",
5+
"access_right": "open",
6+
"license": "MIT",
7+
"creators": [
8+
{
9+
"name": "de Graaf, Daan",
10+
"affiliation": "Eindhoven University of Technology",
11+
"orcid": "0009-0000-0322-1149"
12+
},
13+
{
14+
"name": "Brijder, Robert",
15+
"affiliation": "Eindhoven University of Technology",
16+
"orcid": "0000-0002-8912-1735"
17+
},
18+
{
19+
"name": "Chakraborty, Soham",
20+
"affiliation": "Delft University of Technology",
21+
"orcid": "0000-0002-4454-2050"
22+
},
23+
{
24+
"name": "Fletcher, George H. L.",
25+
"affiliation": "Eindhoven University of Technology",
26+
"orcid": "0000-0003-2111-6769"
27+
},
28+
{
29+
"name": "van de Wall, Bram",
30+
"affiliation": "Eindhoven University of Technology",
31+
"orcid": "0009-0001-3066-863X"
32+
},
33+
{
34+
"name": "Yakovets, Nikolay",
35+
"affiliation": "Eindhoven University of Technology",
36+
"orcid": "0000-0002-1488-1414"
37+
}
38+
],
39+
"keywords": [
40+
"graph algorithms",
41+
"linear algebra",
42+
"domain-specific language",
43+
"graph databases",
44+
"MATLANG",
45+
"WebAssembly"
46+
],
47+
"grants": [
48+
{"id": "10.13039/501100000780::101058573"}
49+
],
50+
"related_identifiers": [
51+
{
52+
"identifier": "10.48550/arXiv.2604.11454",
53+
"relation": "isDocumentedBy",
54+
"resource_type": "publication-preprint"
55+
},
56+
{
57+
"identifier": "https://wildarch.dev/graphalg/playground",
58+
"relation": "isDocumentedBy",
59+
"resource_type": "other"
60+
},
61+
{
62+
"identifier": "https://wildarch.dev/graphalg/tutorial",
63+
"relation": "isDocumentedBy",
64+
"resource_type": "other"
65+
}
66+
],
67+
"communities": [
68+
{"identifier": "scilake_project"},
69+
{"identifier": "eu"}
70+
]
71+
}

‎CITATION.cff‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
cff-version: 1.2.0
2+
message: "If you use GraphAlg, please cite it using the metadata below."
3+
title: "GraphAlg"
4+
abstract: "GraphAlg is a domain-specific language for graph algorithms based on linear algebra, designed to be embedded in databases. It compiles via a MATLANG-based core language to relational algebra, and is integrated into AvantGraph through the Cypher `WITH ALGORITHM` clause."
5+
type: software
6+
authors:
7+
- family-names: "de Graaf"
8+
given-names: "Daan"
9+
email: "d.j.a.d.graaf@tue.nl"
10+
orcid: "https://orcid.org/0009-0000-0322-1149"
11+
affiliation: "Eindhoven University of Technology"
12+
- family-names: "Brijder"
13+
given-names: "Robert"
14+
email: "r.brijder@tue.nl"
15+
orcid: "https://orcid.org/0000-0002-8912-1735"
16+
affiliation: "Eindhoven University of Technology"
17+
- family-names: "Chakraborty"
18+
given-names: "Soham"
19+
orcid: "https://orcid.org/0000-0002-4454-2050"
20+
affiliation: "Delft University of Technology"
21+
- family-names: "Fletcher"
22+
given-names: "George H. L."
23+
email: "g.h.l.fletcher@tue.nl"
24+
orcid: "https://orcid.org/0000-0003-2111-6769"
25+
affiliation: "Eindhoven University of Technology"
26+
- family-names: "van de Wall"
27+
given-names: "Bram"
28+
email: "a.a.g.v.d.wall@tue.nl"
29+
orcid: "https://orcid.org/0009-0001-3066-863X"
30+
affiliation: "Eindhoven University of Technology"
31+
- family-names: "Yakovets"
32+
given-names: "Nikolay"
33+
email: "hush@tue.nl"
34+
orcid: "https://orcid.org/0000-0002-1488-1414"
35+
affiliation: "Eindhoven University of Technology"
36+
license: MIT
37+
repository-code: "https://github.com/wildarch/graphalg"
38+
url: "https://wildarch.dev/graphalg"
39+
keywords:
40+
- graph algorithms
41+
- linear algebra
42+
- domain-specific language
43+
- graph databases
44+
- MATLANG

‎README.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# GraphAlg: A Embeddable Language for Writing Graph Algorithm in Linear Algebra
1+
# GraphAlg: An Embeddable Language for Writing Graph Algorithms in Linear Algebra
2+
3+
GraphAlg is a domain-specific language for graph algorithms based on linear algebra,
4+
designed to be embedded in databases. Try it in the browser via the
5+
[Playground](https://wildarch.dev/graphalg/playground) or learn the language with the
6+
[interactive tutorial](https://wildarch.dev/graphalg/tutorial).
7+
28
This repository contains code related to the GraphAlg language:
39
- `codemirror-lang-graphalg`: Language Support for Codemirror
410
- `compiler/`: The GraphAlg compiler.
@@ -7,6 +13,16 @@ This repository contains code related to the GraphAlg language:
713
- `spec/`: The GraphAlg Language Specification
814
- `tutorial/`: A tutorial for new GraphAlg users
915

16+
## Citation
17+
18+
If you use GraphAlg in your work, please cite the software via the metadata in
19+
[`CITATION.cff`](./CITATION.cff) (or the Zenodo DOI for a specific release).
20+
21+
## Acknowledgement
22+
23+
This work was supported by the European Union's Horizon Europe research and innovation
24+
programme under grant agreement **No. 101058573** ([SciLake](https://scilake.eu/)).
25+
1026
## Building
1127
This assumes you are using the provided [devcontainer](https://containers.dev/) development environment.
1228

0 commit comments

Comments
 (0)