Skip to content

Commit 931870d

Browse files
committed
add readme, remove justfile
1 parent 1ad9ad9 commit 931870d

File tree

2 files changed

+52
-4
lines changed

2 files changed

+52
-4
lines changed

Justfile

Lines changed: 0 additions & 4 deletions
This file was deleted.

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Algorithms for Intelligent Data Analytics website
2+
3+
This repository hosts the sources for the [AIDALab](https://aidalabdei.github.io/) website.
4+
5+
The `index.html` file can be edited directly. Adding new publications is automated with the
6+
`update-papers.py` script.
7+
8+
## Updating the publications
9+
10+
Running `python update-papers.py` will query DBLP for the papers written by the members of the group.
11+
The resulting information is integrated with papers listed in `manual_pubs.json` and used to update
12+
the `index.html` file.
13+
As part of normal operations no other actions are required, other than running the `update-papers.py` script.
14+
15+
Papers from Arxiv are not considered.
16+
17+
### Adding papers that are not indexed by DBLP
18+
19+
To add a paper that is not listed in DBLP, one can add an entry to `manual_pubs.json` with the following format:
20+
21+
```json
22+
{
23+
"authors": [
24+
"First Author",
25+
"Second Author"
26+
],
27+
"key": "a-unique-key-for-the-paper",
28+
"title": "title of the paper",
29+
"url": "url to retrieve the paper",
30+
"venue": "Journal or conference",
31+
"year": "year of publication"
32+
},
33+
```
34+
35+
After editing the file (which is indexed in `git`) one should run
36+
37+
```
38+
python update-papers.py
39+
```
40+
to see the changes included in `index.html`
41+
42+
### Adding paper authors
43+
44+
The list of people whose papers will be looked for in DBLP is at the beginning of the
45+
`update-papers.py` script:
46+
47+
https://github.com/aidaLabDEI/aidaLabDEI.github.io/blob/1ad9ad9143e782bf19cf7187ec3113739ce71ba0/update-papers.py#L5-L16
48+
49+
To add new person, simply add a new entry following the same structure.
50+
If someone leaves the group, we can modify the corresponding `to_year` entry, so that only papers that were
51+
published while in the group are included in the website.
52+

0 commit comments

Comments
 (0)