You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[CodeGRITS](https://codegrits.github.io/CodeGRITS/) stands for **G**aze **R**ecording & **I**DE **T**racking **S**ystem. It's a plugin developed by the [SaNDwich Lab](https://toby.li/) and is specially designed for empirical software engineering researchers. CodeGRITS is built on top of [IntelliJ Platform SDK](https://plugins.jetbrains.com/docs/intellij/welcome.html), with wide compatibility with the entire family of [JetBrains IDEs](https://www.jetbrains.com/) and [Tobii eye-tracking devices](https://www.tobii.com/), to track developers’ IDE interactions and eye gaze data.
The data collected by CodeGRITS can be used by empirical SE researchers to understand the behaviors of developers,
22
-
especially those related to eye gaze. CodeGRITS also provides a [real-time data API](developer.md)
23
-
for future plugin developers and researchers to design context-aware programming support tools.
11
+
The [website](https://codegrits.github.io/CodeGRITS/)'s source code is stored in the `./site` folder of this repository and deployed via GitHub Pages. The [JavaDoc](https://codegrits.github.io/CodeGRITS/docs/index.html) documentation is located in the `./site/docs` folder of this repository. They are archived together with the source code in the Software Heritage.
12
+
13
+
The data collected by CodeGRITS can be used by empirical SE researchers to understand the behaviors of developers, especially those related to eye gaze. CodeGRITS also provides a [real-time data API](developer.md)for future plugin developers and researchers to design context-aware programming support tools.
24
14
25
-
We provide an example project [DataStreamReceiver](https://github.com/codegrits/DataStreamReceiver) that builds on top
26
-
of the real-time data API. It is designed to receive the IDE and eye tracking data and directly visualize them in two
27
-
separate windows.
15
+
We provide an example project [DataStreamReceiver](https://github.com/codegrits/DataStreamReceiver) that builds on top of the real-time data API. It is designed to receive the IDE and eye tracking data and directly visualize them in two separate windows.
28
16
29
17
## Key Features
30
18
31
19
-:mag:**IDE Tracking**: CodeGRITS tracks developers’ IDE interactions, including mouse clicks, keyboard inputs, etc.
32
-
-:eye:**Eye Tracking**: CodeGRITS tracks developers’ eye gaze data
33
-
from [Tobii eye-tracking devices](https://www.tobii.com/), and maps them to corresponding source code elements.
20
+
-:eye:**Eye Tracking**: CodeGRITS tracks developers’ eye gaze data from [Tobii eye-tracking devices](https://www.tobii.com/), and maps them to corresponding source code elements.
34
21
-:computer:**Screen Recording**: CodeGRITS simultaneously records developers’ screen for visualizing their behaviors.
35
-
- 🔨 **Research Toolkit**: CodeGRITS provides a set of extra features for empirical SE
36
-
researchers, including dynamic configuration, activity labeling, real-time data API, etc.
37
-
- 🗃️ **Data Export**: CodeGRITS exports data in XML format for further data analysis. See [Data Format](data.md)
38
-
for more details.
22
+
- 🔨 **Research Toolkit**: CodeGRITS provides a set of extra features for empirical SE researchers, including dynamic configuration, activity labeling, real-time data API, etc.
23
+
- 🗃️ **Data Export**: CodeGRITS exports data in XML format for further data analysis. See [Data Format](data.md) for more details.
39
24
40
25
### Cross-platform and Multilingual Support
41
26
42
-
-[x] CodeGRITS provides cross-platform support for Windows, macOS,
43
-
and Linux, and is expected to be compatible with the entire family of JetBrains IDEs, including IntelliJ IDEA,
44
-
PyCharm, WebStorm, etc.
45
-
-[x] CodeGRITS could extract the abstract syntax tree (AST) structure of eye gazes on multiple
46
-
programming languages, as long as the IDE supports them, including Java, Python, C/C++, JavaScript, etc.
27
+
-[x] CodeGRITS provides cross-platform support for Windows, macOS, and Linux, and is expected to be compatible with the entire family of JetBrains IDEs, including IntelliJ IDEA, PyCharm, WebStorm, etc.
28
+
-[x] CodeGRITS could extract the abstract syntax tree (AST) structure of eye gazes on multiple programming languages, as long as the IDE supports them, including Java, Python, C/C++, JavaScript, etc.
47
29
48
30
## Usage Guide
49
31
50
-
Please see the [CodeGRITS website](https://codegrits.github.io/CodeGRITS/) for more details.
51
-
The Javadoc documentation is available [here](https://codegrits.github.io/CodeGRITS/docs/index.html).
32
+
Please see the [CodeGRITS website](https://codegrits.github.io/CodeGRITS/) for more details. The Javadoc documentation is available [here](https://codegrits.github.io/CodeGRITS/docs/index.html).
52
33
53
34
## Citation
54
35
55
-
The paper of CodeGRITS has been accepted
56
-
by [ICSE 2024 Demonstrations Track](https://conf.researchr.org/track/icse-2024/icse-2024-demonstrations).
57
-
The PDF version is available [here](https://codegrits.github.io/CodeGRITS/static/paper.pdf).
58
-
The [video demonstration](https://www.youtube.com/watch?v=d-YsJfW2NMI) is available on YouTube.
36
+
The paper of CodeGRITS has been accepted by [ICSE 2024 Demonstrations Track](https://conf.researchr.org/track/icse-2024/icse-2024-demonstrations). The PDF version is available [here](https://codegrits.github.io/CodeGRITS/static/paper.pdf). The [video demonstration](https://www.youtube.com/watch?v=d-YsJfW2NMI) is available on YouTube.
59
37
60
38
Please cite the following if you use CodeGRITS in your research.
61
39
@@ -71,5 +49,4 @@ Please cite the following if you use CodeGRITS in your research.
71
49
72
50
## Contact us
73
51
74
-
Please feel free to contact Ningzhi Tang at ntang@nd.edu or Junwen An at jan2@nd.edu/feasiblechart@gmail.com
75
-
if you have any questions or suggestions.
52
+
Please feel free to contact Ningzhi Tang at ntang@nd.edu or Junwen An at jan2@nd.edu/feasiblechart@gmail.com if you have any questions or suggestions.
0 commit comments