ricgraph 2.9__tar.gz → 2.10__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ricgraph-2.10/PKG-INFO +146 -0
- ricgraph-2.10/README-PyPI.md +121 -0
- {ricgraph-2.9 → ricgraph-2.10}/README.md +121 -77
- {ricgraph-2.9 → ricgraph-2.10}/pyproject.toml +7 -5
- {ricgraph-2.9 → ricgraph-2.10}/ricgraph/ricgraph.py +1 -1
- ricgraph-2.10/ricgraph.egg-info/PKG-INFO +146 -0
- ricgraph-2.9/PKG-INFO +0 -125
- ricgraph-2.9/README-PyPI.md +0 -101
- ricgraph-2.9/ricgraph.egg-info/PKG-INFO +0 -125
- {ricgraph-2.9 → ricgraph-2.10}/LICENSE +0 -0
- {ricgraph-2.9 → ricgraph-2.10}/ricgraph/__init__.py +0 -0
- {ricgraph-2.9 → ricgraph-2.10}/ricgraph.egg-info/SOURCES.txt +0 -0
- {ricgraph-2.9 → ricgraph-2.10}/ricgraph.egg-info/dependency_links.txt +0 -0
- {ricgraph-2.9 → ricgraph-2.10}/ricgraph.egg-info/requires.txt +0 -0
- {ricgraph-2.9 → ricgraph-2.10}/ricgraph.egg-info/top_level.txt +0 -0
- {ricgraph-2.9 → ricgraph-2.10}/setup.cfg +0 -0
ricgraph-2.10/PKG-INFO
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ricgraph
|
|
3
|
+
Version: 2.10
|
|
4
|
+
Summary: Ricgraph - Research in context graph
|
|
5
|
+
Author: Rik D.T. Janssen
|
|
6
|
+
Project-URL: Website, https://www.ricgraph.eu
|
|
7
|
+
Project-URL: Documentation, https://docs.ricgraph.eu
|
|
8
|
+
Project-URL: GitHub, https://github.com/UtrechtUniversity/ricgraph
|
|
9
|
+
Project-URL: Issues, https://github.com/UtrechtUniversity/ricgraph/issues
|
|
10
|
+
Project-URL: Download, https://github.com/UtrechtUniversity/ricgraph/releases
|
|
11
|
+
Project-URL: Release Notes, https://github.com/UtrechtUniversity/ricgraph/releases
|
|
12
|
+
Keywords: Research in context graph,Ricgraph,Ricgraph Explorer,Ricgraph REST API,Data enrichment,Data harvesting,Data linking,Enrichment,Graph,Graph database,Harvest,Harvest data,Harvester,Knowledge graph,Linked data,Metadata,Utrecht University,Visualization
|
|
13
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Requires-Python: >=3.9
|
|
18
|
+
Description-Content-Type: text/markdown
|
|
19
|
+
License-File: LICENSE
|
|
20
|
+
Requires-Dist: neo4j>=5.8
|
|
21
|
+
Requires-Dist: numpy
|
|
22
|
+
Requires-Dist: pandas
|
|
23
|
+
Requires-Dist: requests
|
|
24
|
+
Dynamic: license-file
|
|
25
|
+
|
|
26
|
+
[](https://doi.org/10.5281/zenodo.7524314)
|
|
27
|
+
[](https://doi.org/10.1016/j.softx.2024.101736)
|
|
28
|
+
[](https://www.ricgraph.eu)
|
|
29
|
+
[](https://docs.ricgraph.eu)
|
|
30
|
+
[](https://github.com/UtrechtUniversity/ricgraph)
|
|
31
|
+
|
|
32
|
+
[](https://github.com/UtrechtUniversity/ricgraph/releases)
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
[](https://pypi.org/project/ricgraph)
|
|
36
|
+
[](https://pypistats.org/packages/ricgraph)
|
|
37
|
+
[](LICENSE)
|
|
38
|
+
|
|
39
|
+
<!---
|
|
40
|
+
Note, some lines above end in two spaces, to force a line break but not a paragraph break.
|
|
41
|
+
We use color=#4c1 (green), that color is used by the 'repo status' badge.
|
|
42
|
+
Documentation about the Podman badges can be found here: https://github.com/eggplants/ghcr-badge.
|
|
43
|
+
--->
|
|
44
|
+
|
|
45
|
+
<img alt="Ricgraph logo" src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/refs/heads/main/docs/images/ricgraph_logo.png" width="30%">
|
|
46
|
+
|
|
47
|
+
# Ricgraph - Research in context graph
|
|
48
|
+
|
|
49
|
+
## What is Ricgraph?
|
|
50
|
+
|
|
51
|
+
Ricgraph, also known as Research in context graph, enables the exploration of researchers,
|
|
52
|
+
teams, their results,
|
|
53
|
+
collaborations, skills, projects, and the relations between these items.
|
|
54
|
+
|
|
55
|
+
Ricgraph can store many types of items into a single graph.
|
|
56
|
+
These items can be obtained from various systems and from
|
|
57
|
+
multiple organizations. Ricgraph facilitates reasoning about these
|
|
58
|
+
items because it infers new relations between items,
|
|
59
|
+
relations that are not present in any of the separate source systems.
|
|
60
|
+
It is flexible and extensible, and can be
|
|
61
|
+
adapted to new application areas.
|
|
62
|
+
|
|
63
|
+
## Motivation
|
|
64
|
+
|
|
65
|
+
Ricgraph is software that is about
|
|
66
|
+
relations between items. These items can be collected from various source
|
|
67
|
+
systems and from multiple organizations. We
|
|
68
|
+
explain how Ricgraph works by applying it to the application area
|
|
69
|
+
*research information*. We show the insights that can be
|
|
70
|
+
obtained by combining information from various source systems,
|
|
71
|
+
insight arising from new relations that are not present
|
|
72
|
+
in each separate source system.
|
|
73
|
+
|
|
74
|
+
*Research information* is about anything related to research: research
|
|
75
|
+
results, the persons in a research team, their
|
|
76
|
+
collaborations, their skills, projects in which they have
|
|
77
|
+
participated, as well as the relations between these entities.
|
|
78
|
+
Examples of *research results* are publications, data sets, and software.
|
|
79
|
+
|
|
80
|
+
The following sections show three use cases
|
|
81
|
+
that use different types of information (called *items*):
|
|
82
|
+
researchers, skills, publications,
|
|
83
|
+
etc. Most often, these types of information are not stored in
|
|
84
|
+
one system, so the use cases may be difficult or
|
|
85
|
+
time-consuming to answer. However, by using Ricgraph, these
|
|
86
|
+
use cases (and many others) are easy to answer, as will be
|
|
87
|
+
explained throughout this documentation.
|
|
88
|
+
|
|
89
|
+
Although this documentation illustrates Ricgraph in the application area
|
|
90
|
+
research information, the principle “relations
|
|
91
|
+
between items from various source systems” is general,
|
|
92
|
+
so Ricgraph can be used in other application areas.
|
|
93
|
+
|
|
94
|
+
### Use case for a journalist
|
|
95
|
+
As a journalist, I want to find researchers with a certain skill S and their publications,
|
|
96
|
+
so that I can interview them for a newspaper article.
|
|
97
|
+
Example skills can be: *climate change* or *stem cells*.
|
|
98
|
+
The items surrounded by the red line are the solution to this use case.
|
|
99
|
+
|
|
100
|
+
<!--
|
|
101
|
+
The 'width=...' in the lines below to include a figure are necessary for
|
|
102
|
+
the documentation generated with Quarto, a.o. for the documentation website.
|
|
103
|
+
We will need a width instead of a height to prevent right margin overflows
|
|
104
|
+
on small mobile screens.
|
|
105
|
+
-->
|
|
106
|
+
|
|
107
|
+
<img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/journalist-use-case.jpg" alt="Ricgraph use case for a journalist." width="70%">
|
|
108
|
+
|
|
109
|
+
### Use case for a librarian
|
|
110
|
+
As a librarian, I want to enrich my local research information system with research results
|
|
111
|
+
from person A that are in other systems (in orange, *RIS2*) but not in
|
|
112
|
+
ours (in green, *RIS1*), so that we have a more complete view of research at our university.
|
|
113
|
+
The items surrounded by the red line are the solution to this use case.
|
|
114
|
+
|
|
115
|
+
<img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/librarian-use-case.jpg" alt="Ricgraph use case for a librarian." width="75%">
|
|
116
|
+
|
|
117
|
+
### Use case for a researcher
|
|
118
|
+
As a researcher A, I want to find researchers from other universities that have
|
|
119
|
+
co-authored publications written by the co-authors of my own publications,
|
|
120
|
+
so that I can read their publications to find out if we share common research interests.
|
|
121
|
+
The items surrounded by the red line are the solution to this use case.
|
|
122
|
+
|
|
123
|
+
<img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/researcher-use-case.jpg" alt="Ricgraph use case for a researcher." width="35%">
|
|
124
|
+
|
|
125
|
+
### Main contributions of Ricgraph
|
|
126
|
+
|
|
127
|
+
* Ricgraph can store many types of items in a single graph.
|
|
128
|
+
* Ricgraph harvests multiple source systems into a single graph.
|
|
129
|
+
* Ricgraph Explorer is the exploration tool for Ricgraph.
|
|
130
|
+
* Ricgraph facilitates reasoning about items because it infers new relations between items.
|
|
131
|
+
* Ricgraph can be tailored for an application area.
|
|
132
|
+
|
|
133
|
+
### Read more about Ricgraph
|
|
134
|
+
|
|
135
|
+
For a gentle introduction in Ricgraph, read the reference publication:
|
|
136
|
+
Rik D.T. Janssen (2024). Ricgraph: A flexible and extensible graph to explore research in
|
|
137
|
+
context from various systems. *SoftwareX*, 26(101736).
|
|
138
|
+
[https://doi.org/10.1016/j.softx.2024.101736](https://doi.org/10.1016/j.softx.2024.101736).
|
|
139
|
+
|
|
140
|
+
You might also want to read the documentation on
|
|
141
|
+
[https://docs.ricgraph.eu](https://docs.ricgraph.eu).
|
|
142
|
+
You can also go to the [Ricgraph GitHub repository](https://github.com/UtrechtUniversity/ricgraph).
|
|
143
|
+
To use Ricgraph, installing the [Ricgraph package from PyPI](https://pypi.org/project/ricgraph)
|
|
144
|
+
is not sufficient. Please read the
|
|
145
|
+
installation instructions in the Ricgraph GitHub repository.
|
|
146
|
+
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
[](https://doi.org/10.5281/zenodo.7524314)
|
|
2
|
+
[](https://doi.org/10.1016/j.softx.2024.101736)
|
|
3
|
+
[](https://www.ricgraph.eu)
|
|
4
|
+
[](https://docs.ricgraph.eu)
|
|
5
|
+
[](https://github.com/UtrechtUniversity/ricgraph)
|
|
6
|
+
|
|
7
|
+
[](https://github.com/UtrechtUniversity/ricgraph/releases)
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
[](https://pypi.org/project/ricgraph)
|
|
11
|
+
[](https://pypistats.org/packages/ricgraph)
|
|
12
|
+
[](LICENSE)
|
|
13
|
+
|
|
14
|
+
<!---
|
|
15
|
+
Note, some lines above end in two spaces, to force a line break but not a paragraph break.
|
|
16
|
+
We use color=#4c1 (green), that color is used by the 'repo status' badge.
|
|
17
|
+
Documentation about the Podman badges can be found here: https://github.com/eggplants/ghcr-badge.
|
|
18
|
+
--->
|
|
19
|
+
|
|
20
|
+
<img alt="Ricgraph logo" src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/refs/heads/main/docs/images/ricgraph_logo.png" width="30%">
|
|
21
|
+
|
|
22
|
+
# Ricgraph - Research in context graph
|
|
23
|
+
|
|
24
|
+
## What is Ricgraph?
|
|
25
|
+
|
|
26
|
+
Ricgraph, also known as Research in context graph, enables the exploration of researchers,
|
|
27
|
+
teams, their results,
|
|
28
|
+
collaborations, skills, projects, and the relations between these items.
|
|
29
|
+
|
|
30
|
+
Ricgraph can store many types of items into a single graph.
|
|
31
|
+
These items can be obtained from various systems and from
|
|
32
|
+
multiple organizations. Ricgraph facilitates reasoning about these
|
|
33
|
+
items because it infers new relations between items,
|
|
34
|
+
relations that are not present in any of the separate source systems.
|
|
35
|
+
It is flexible and extensible, and can be
|
|
36
|
+
adapted to new application areas.
|
|
37
|
+
|
|
38
|
+
## Motivation
|
|
39
|
+
|
|
40
|
+
Ricgraph is software that is about
|
|
41
|
+
relations between items. These items can be collected from various source
|
|
42
|
+
systems and from multiple organizations. We
|
|
43
|
+
explain how Ricgraph works by applying it to the application area
|
|
44
|
+
*research information*. We show the insights that can be
|
|
45
|
+
obtained by combining information from various source systems,
|
|
46
|
+
insight arising from new relations that are not present
|
|
47
|
+
in each separate source system.
|
|
48
|
+
|
|
49
|
+
*Research information* is about anything related to research: research
|
|
50
|
+
results, the persons in a research team, their
|
|
51
|
+
collaborations, their skills, projects in which they have
|
|
52
|
+
participated, as well as the relations between these entities.
|
|
53
|
+
Examples of *research results* are publications, data sets, and software.
|
|
54
|
+
|
|
55
|
+
The following sections show three use cases
|
|
56
|
+
that use different types of information (called *items*):
|
|
57
|
+
researchers, skills, publications,
|
|
58
|
+
etc. Most often, these types of information are not stored in
|
|
59
|
+
one system, so the use cases may be difficult or
|
|
60
|
+
time-consuming to answer. However, by using Ricgraph, these
|
|
61
|
+
use cases (and many others) are easy to answer, as will be
|
|
62
|
+
explained throughout this documentation.
|
|
63
|
+
|
|
64
|
+
Although this documentation illustrates Ricgraph in the application area
|
|
65
|
+
research information, the principle “relations
|
|
66
|
+
between items from various source systems” is general,
|
|
67
|
+
so Ricgraph can be used in other application areas.
|
|
68
|
+
|
|
69
|
+
### Use case for a journalist
|
|
70
|
+
As a journalist, I want to find researchers with a certain skill S and their publications,
|
|
71
|
+
so that I can interview them for a newspaper article.
|
|
72
|
+
Example skills can be: *climate change* or *stem cells*.
|
|
73
|
+
The items surrounded by the red line are the solution to this use case.
|
|
74
|
+
|
|
75
|
+
<!--
|
|
76
|
+
The 'width=...' in the lines below to include a figure are necessary for
|
|
77
|
+
the documentation generated with Quarto, a.o. for the documentation website.
|
|
78
|
+
We will need a width instead of a height to prevent right margin overflows
|
|
79
|
+
on small mobile screens.
|
|
80
|
+
-->
|
|
81
|
+
|
|
82
|
+
<img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/journalist-use-case.jpg" alt="Ricgraph use case for a journalist." width="70%">
|
|
83
|
+
|
|
84
|
+
### Use case for a librarian
|
|
85
|
+
As a librarian, I want to enrich my local research information system with research results
|
|
86
|
+
from person A that are in other systems (in orange, *RIS2*) but not in
|
|
87
|
+
ours (in green, *RIS1*), so that we have a more complete view of research at our university.
|
|
88
|
+
The items surrounded by the red line are the solution to this use case.
|
|
89
|
+
|
|
90
|
+
<img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/librarian-use-case.jpg" alt="Ricgraph use case for a librarian." width="75%">
|
|
91
|
+
|
|
92
|
+
### Use case for a researcher
|
|
93
|
+
As a researcher A, I want to find researchers from other universities that have
|
|
94
|
+
co-authored publications written by the co-authors of my own publications,
|
|
95
|
+
so that I can read their publications to find out if we share common research interests.
|
|
96
|
+
The items surrounded by the red line are the solution to this use case.
|
|
97
|
+
|
|
98
|
+
<img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/researcher-use-case.jpg" alt="Ricgraph use case for a researcher." width="35%">
|
|
99
|
+
|
|
100
|
+
### Main contributions of Ricgraph
|
|
101
|
+
|
|
102
|
+
* Ricgraph can store many types of items in a single graph.
|
|
103
|
+
* Ricgraph harvests multiple source systems into a single graph.
|
|
104
|
+
* Ricgraph Explorer is the exploration tool for Ricgraph.
|
|
105
|
+
* Ricgraph facilitates reasoning about items because it infers new relations between items.
|
|
106
|
+
* Ricgraph can be tailored for an application area.
|
|
107
|
+
|
|
108
|
+
### Read more about Ricgraph
|
|
109
|
+
|
|
110
|
+
For a gentle introduction in Ricgraph, read the reference publication:
|
|
111
|
+
Rik D.T. Janssen (2024). Ricgraph: A flexible and extensible graph to explore research in
|
|
112
|
+
context from various systems. *SoftwareX*, 26(101736).
|
|
113
|
+
[https://doi.org/10.1016/j.softx.2024.101736](https://doi.org/10.1016/j.softx.2024.101736).
|
|
114
|
+
|
|
115
|
+
You might also want to read the documentation on
|
|
116
|
+
[https://docs.ricgraph.eu](https://docs.ricgraph.eu).
|
|
117
|
+
You can also go to the [Ricgraph GitHub repository](https://github.com/UtrechtUniversity/ricgraph).
|
|
118
|
+
To use Ricgraph, installing the [Ricgraph package from PyPI](https://pypi.org/project/ricgraph)
|
|
119
|
+
is not sufficient. Please read the
|
|
120
|
+
installation instructions in the Ricgraph GitHub repository.
|
|
121
|
+
|
|
@@ -1,12 +1,14 @@
|
|
|
1
|
-
[](https://www.ricgraph.eu)
|
|
4
|
-
](https://doi.org/10.5281/zenodo.7524314)
|
|
2
|
+
[](https://doi.org/10.1016/j.softx.2024.101736)
|
|
3
|
+
[](https://www.ricgraph.eu)
|
|
4
|
+
[](https://docs.ricgraph.eu)
|
|
5
|
+
[](https://github.com/UtrechtUniversity/ricgraph)
|
|
6
|
+
|
|
7
|
+
[](https://github.com/UtrechtUniversity/ricgraph/releases)
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
[](https://pypi.org/project/ricgraph)
|
|
11
|
+
[](https://pypistats.org/packages/ricgraph)
|
|
10
12
|
[](https://github.com/UtrechtUniversity/ricgraph/blob/main/docs/ricgraph_containerized.md)
|
|
11
13
|
[](https://github.com/utrechtuniversity/ricgraph/pkgs/container/ricgraph)
|
|
12
14
|
[](LICENSE)
|
|
@@ -15,19 +17,28 @@
|
|
|
15
17
|
[](https://fairsoftwarechecklist.net/v0.2?f=31&a=32113&i=32110&r=123)
|
|
16
18
|
|
|
17
19
|
<!---
|
|
18
|
-
Note,
|
|
19
|
-
'PyPI downloads' end in two spaces, to force a line break but not a paragraph break.
|
|
20
|
-
Similar for others.
|
|
20
|
+
Note, some lines above end in two spaces, to force a line break but not a paragraph break.
|
|
21
21
|
We use color=#4c1 (green), that color is used by the 'repo status' badge.
|
|
22
22
|
Documentation about the Podman badges can be found here: https://github.com/eggplants/ghcr-badge.
|
|
23
23
|
--->
|
|
24
24
|
|
|
25
|
-
<img alt="Ricgraph logo" src="docs/images/ricgraph_logo.png"
|
|
25
|
+
<img alt="Ricgraph logo" src="docs/images/ricgraph_logo.png" width="30%">
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
<!---
|
|
28
|
+
The Mark below is used in file
|
|
29
|
+
https://github.com/UtrechtUniversity/ricgraph-documentation/blob/main/Makefile
|
|
30
|
+
to remove everything up and including these lines. Do not modify the text in it.
|
|
31
|
+
--->
|
|
32
|
+
|
|
33
|
+
<!--- Mark to remove everything up to here --->
|
|
34
|
+
|
|
35
|
+
# Ricgraph - Research in context graph
|
|
28
36
|
|
|
29
|
-
[
|
|
30
|
-
[
|
|
37
|
+
[Read the Tutorial Ricgraph](docs/ricgraph_tutorial.md#tutorial-ricgraph---research-in-context-graph).
|
|
38
|
+
Go to the [documentation website for Ricgraph](https://docs.ricgraph.eu).
|
|
39
|
+
|
|
40
|
+
[Table of contents of Ricgraph documentation](docs/ricgraph_toc_documentation.md#table-of-contents-ricgraph-documentation) and
|
|
41
|
+
[Index of Ricgraph documentation](docs/ricgraph_index_documentation.md#index-ricgraph-documentation).
|
|
31
42
|
|
|
32
43
|
## What is Ricgraph?
|
|
33
44
|
|
|
@@ -46,45 +57,69 @@ adapted to new application areas.
|
|
|
46
57
|
Throughout this documentation, we illustrate how Ricgraph works by applying
|
|
47
58
|
it to the application area research information.
|
|
48
59
|
|
|
49
|
-
|
|
60
|
+
## Motivation
|
|
50
61
|
|
|
51
|
-
Ricgraph
|
|
52
|
-
relations between items. These items can be collected from various source
|
|
62
|
+
Ricgraph is software that is about
|
|
63
|
+
relations between items. These items can be collected from various source
|
|
53
64
|
systems and from multiple organizations. We
|
|
54
|
-
explain how Ricgraph works by applying it to the application area
|
|
65
|
+
explain how Ricgraph works by applying it to the application area
|
|
55
66
|
*research information*. We show the insights that can be
|
|
56
|
-
obtained by combining information from various source systems,
|
|
67
|
+
obtained by combining information from various source systems,
|
|
57
68
|
insight arising from new relations that are not present
|
|
58
69
|
in each separate source system.
|
|
59
70
|
|
|
60
|
-
*Research information* is about anything related to research: research
|
|
71
|
+
*Research information* is about anything related to research: research
|
|
61
72
|
results, the persons in a research team, their
|
|
62
|
-
collaborations, their skills, projects in which they have
|
|
73
|
+
collaborations, their skills, projects in which they have
|
|
63
74
|
participated, as well as the relations between these entities.
|
|
64
75
|
Examples of *research results* are publications, data sets, and software.
|
|
65
76
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
| Use case | In Ricgraph (click to enlarge) |
|
|
69
|
-
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
|
|
70
|
-
| As a journalist, I want to find researchers with a certain skill S and their publications, so that I can interview them for a newspaper article. Example skills can be: *climate change* or *stem cells*. | <img src="docs/images/journalist-use-case.jpg" width="700"> |
|
|
71
|
-
| As a librarian, I want to enrich my local research information system with research results from person A that are in other systems (in orange, *RIS2*) but not in ours (in green, *RIS1*), so that we have a more complete view of research at our university. | <img src="docs/images/librarian-use-case.jpg" width="700"> |
|
|
72
|
-
| As a researcher A, I want to find researchers from other universities that have co-authored publications written by the co-authors of my own publications, so that I can read their publications to find out if we share common research interests. | <img src="docs/images/researcher-use-case.jpg" width="700"> |
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
These use cases use different types of information (called *items*):
|
|
77
|
+
The following sections show three use cases
|
|
78
|
+
that use different types of information (called *items*):
|
|
76
79
|
researchers, skills, publications,
|
|
77
|
-
etc. Most often, these types of information are not stored in
|
|
80
|
+
etc. Most often, these types of information are not stored in
|
|
78
81
|
one system, so the use cases may be difficult or
|
|
79
|
-
time-consuming to answer. However, by using Ricgraph, these
|
|
82
|
+
time-consuming to answer. However, by using Ricgraph, these
|
|
80
83
|
use cases (and many others) are easy to answer, as will be
|
|
81
84
|
explained throughout this documentation.
|
|
82
85
|
|
|
83
|
-
Although this documentation illustrates Ricgraph in the application area
|
|
86
|
+
Although this documentation illustrates Ricgraph in the application area
|
|
84
87
|
research information, the principle “relations
|
|
85
|
-
between items from various source systems” is general,
|
|
88
|
+
between items from various source systems” is general,
|
|
86
89
|
so Ricgraph can be used in other application areas.
|
|
87
90
|
|
|
91
|
+
### Use case for a journalist
|
|
92
|
+
As a journalist, I want to find researchers with a certain skill S and their publications,
|
|
93
|
+
so that I can interview them for a newspaper article.
|
|
94
|
+
Example skills can be: *climate change* or *stem cells*.
|
|
95
|
+
The items surrounded by the red line are the solution to this use case.
|
|
96
|
+
|
|
97
|
+
<!--
|
|
98
|
+
The 'width=...' in the lines below to include a figure are necessary for
|
|
99
|
+
the documentation generated with Quarto, a.o. for the documentation website.
|
|
100
|
+
We will need a width instead of a height to prevent right margin overflows
|
|
101
|
+
on small mobile screens.
|
|
102
|
+
-->
|
|
103
|
+
|
|
104
|
+
<img src="docs/images/journalist-use-case.jpg" alt="Ricgraph use case for a journalist." width="70%">
|
|
105
|
+
|
|
106
|
+
### Use case for a librarian
|
|
107
|
+
As a librarian, I want to enrich my local research information system with research results
|
|
108
|
+
from person A that are in other systems (in orange, *RIS2*) but not in
|
|
109
|
+
ours (in green, *RIS1*), so that we have a more complete view of research at our university.
|
|
110
|
+
The items surrounded by the red line are the solution to this use case.
|
|
111
|
+
|
|
112
|
+
<img src="docs/images/librarian-use-case.jpg" alt="Ricgraph use case for a librarian." width="75%">
|
|
113
|
+
|
|
114
|
+
### Use case for a researcher
|
|
115
|
+
As a researcher A, I want to find researchers from other universities that have
|
|
116
|
+
co-authored publications written by the co-authors of my own publications,
|
|
117
|
+
so that I can read their publications to find out if we share common research interests.
|
|
118
|
+
The items surrounded by the red line are the solution to this use case.
|
|
119
|
+
|
|
120
|
+
<img src="docs/images/researcher-use-case.jpg" alt="Ricgraph use case for a researcher." width="35%">
|
|
121
|
+
|
|
122
|
+
|
|
88
123
|
### Main contributions of Ricgraph
|
|
89
124
|
|
|
90
125
|
* Ricgraph can store many types of items in a single graph.
|
|
@@ -95,11 +130,11 @@ so Ricgraph can be used in other application areas.
|
|
|
95
130
|
|
|
96
131
|
### How to use Ricgraph (very short)
|
|
97
132
|
|
|
98
|
-
* [Install and configure Ricgraph](docs/ricgraph_install_configure.md).
|
|
99
|
-
* Start harvesting data, see [Ricgraph harvest scripts](docs/ricgraph_harvest_scripts.md).
|
|
100
|
-
* Use [Ricgraph Explorer](docs/ricgraph_explorer.md),
|
|
133
|
+
* [Install and configure Ricgraph](docs/ricgraph_install_configure.md#install-and-configure-ricgraph).
|
|
134
|
+
* Start harvesting data, see [Ricgraph harvest scripts](docs/ricgraph_harvest_scripts.md#ricgraph-harvest-scripts).
|
|
135
|
+
* Use [Ricgraph Explorer](docs/ricgraph_explorer.md#ricgraph-explorer),
|
|
101
136
|
the exploration tool for Ricgraph.
|
|
102
|
-
* Use the [Ricgraph REST API](docs/ricgraph_restapi.md),
|
|
137
|
+
* Use the [Ricgraph REST API](docs/ricgraph_restapi.md#ricgraph-rest-api),
|
|
103
138
|
the REST API for Ricgraph.
|
|
104
139
|
* Optional: modify code to fit Ricgraph to your specific use case.
|
|
105
140
|
|
|
@@ -110,16 +145,17 @@ For more details, read the remainder of this documentation.
|
|
|
110
145
|
For a gentle introduction in Ricgraph, read the reference publication:
|
|
111
146
|
Rik D.T. Janssen (2024). Ricgraph: A flexible and extensible graph to explore research in
|
|
112
147
|
context from various systems. *SoftwareX*, 26(101736).
|
|
113
|
-
https://doi.org/10.1016/j.softx.2024.101736.
|
|
148
|
+
[https://doi.org/10.1016/j.softx.2024.101736](https://doi.org/10.1016/j.softx.2024.101736).
|
|
114
149
|
|
|
115
150
|
For a further introduction, you might want to read these two presentations:
|
|
151
|
+
|
|
116
152
|
* A general presentation about Ricgraph, presenting Ricgraph in a visual manner:
|
|
117
|
-
https://doi.org/10.5281/zenodo.12634234.
|
|
153
|
+
[https://doi.org/10.5281/zenodo.12634234](https://doi.org/10.5281/zenodo.12634234).
|
|
118
154
|
* A presentation explaining how to enrich
|
|
119
155
|
the [Research Information System Pure](https://www.elsevier.com/solutions/pure)
|
|
120
156
|
(and other source systems) using Ricgraph
|
|
121
157
|
and [BackToPure](https://github.com/UtrechtUniversity/BackToPure):
|
|
122
|
-
https://doi.org/10.5281/zenodo.12634658.
|
|
158
|
+
[https://doi.org/10.5281/zenodo.12634658](https://doi.org/10.5281/zenodo.12634658).
|
|
123
159
|
This presentation explains that after harvesting several Pure systems
|
|
124
160
|
(from different institutions) and other source systems,
|
|
125
161
|
such as [OpenAlex](https://openalex.org),
|
|
@@ -138,7 +174,7 @@ data](#steps-to-take-if-you-would-like-to-install-ricgraph-and-harvest-data),
|
|
|
138
174
|
an [explanation how to use Ricgraph](#steps-to-take-if-you-would-like-to-use-ricgraph),
|
|
139
175
|
and [information about extending Ricgraph](#read-this-in-case-you-would-like-to-extend-ricgraph).
|
|
140
176
|
Of course there are
|
|
141
|
-
[videos we have made to demonstrate Ricgraph](docs/ricgraph_example_use_videos.md),
|
|
177
|
+
[videos we have made to demonstrate Ricgraph](docs/ricgraph_example_use_videos.md#ricgraph-videos),
|
|
142
178
|
and there is an overview of the
|
|
143
179
|
[publications](docs/ricgraph_pubs_pres_news_use_ment.md#ricgraph-publications),
|
|
144
180
|
[presentations](docs/ricgraph_pubs_pres_news_use_ment.md#ricgraph-presentations),
|
|
@@ -148,12 +184,13 @@ and there is an overview of the
|
|
|
148
184
|
[mentions](docs/ricgraph_pubs_pres_news_use_ment.md#ricgraph-mentions)
|
|
149
185
|
of Ricgraph.
|
|
150
186
|
|
|
151
|
-
You can also use the [Table of contents of Ricgraph documentation](docs/ricgraph_toc_documentation.md)
|
|
152
|
-
or the [Index of Ricgraph documentation](docs/ricgraph_index_documentation.md).
|
|
187
|
+
You can also use the [Table of contents of Ricgraph documentation](docs/ricgraph_toc_documentation.md#table-of-contents-ricgraph-documentation)
|
|
188
|
+
or the [Index of Ricgraph documentation](docs/ricgraph_index_documentation.md#index-ricgraph-documentation).
|
|
153
189
|
|
|
154
190
|
## Why Ricgraph?
|
|
155
191
|
|
|
156
192
|
Ricgraph can answer questions like:
|
|
193
|
+
|
|
157
194
|
* Which researcher has contributed to which publication, dataset, software package, project, etc.?
|
|
158
195
|
* Given e.g. a dataset, software package, or project, who has contributed to it?
|
|
159
196
|
* What identifiers does a researcher have (e.g.
|
|
@@ -165,8 +202,9 @@ Ricgraph can answer questions like:
|
|
|
165
202
|
* Which organizations have worked together?
|
|
166
203
|
|
|
167
204
|
Also, more elaborate information can be found using Ricgraph and
|
|
168
|
-
[Ricgraph Explorer](docs/ricgraph_explorer.md), the
|
|
205
|
+
[Ricgraph Explorer](docs/ricgraph_explorer.md#ricgraph-explorer), the
|
|
169
206
|
exploration tool for Ricgraph:
|
|
207
|
+
|
|
170
208
|
* You can find information about persons or their results in a (sub-)organization
|
|
171
209
|
(unit, department, faculty, university).
|
|
172
210
|
For example, you can find out what data sets or software are produced in your faculty.
|
|
@@ -201,12 +239,10 @@ in a university context.
|
|
|
201
239
|
## Examples
|
|
202
240
|
|
|
203
241
|
See the figures below for example graphs that show how Ricgraph works.
|
|
204
|
-
Click a figure to enlarge.
|
|
205
|
-
|
|
206
|
-
| one person with several research outputs | symbols for type of object | colors for source system |
|
|
207
|
-
|---------------------------------------------------------------------------|--------------------------------------------------|----------------------------------------------------------|
|
|
208
|
-
| <img src="docs/images/one-person-with-research-outputs.jpg" height="170"> | <img src="docs/images/symbols.jpg" height="170"> | <img src="docs/images/colors-vertical.jpg" height="170"> |
|
|
209
242
|
|
|
243
|
+
| one person with several research outputs | symbols for type of object | colors for source system |
|
|
244
|
+
|:------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------:|
|
|
245
|
+
| <img alt="One person with several research outputs." src="docs/images/one-person-with-research-outputs.jpg" width="33%"> | <img alt="Symbols for type of object." src="docs/images/symbols.jpg" width="33%"> | <img alt="Colors for source system." src="docs/images/colors-vertical.jpg" width="33%"> |
|
|
210
246
|
|
|
211
247
|
This figure shows one person *A* using a
|
|
212
248
|
[*person-root* node, a node which "represents" a person](docs/ricgraph_details.md#person-root-node-in-ricgraph)
|
|
@@ -225,9 +261,9 @@ the software package is from the
|
|
|
225
261
|
[Research Software Directory](https://research-software-directory.org) (in blue).
|
|
226
262
|
|
|
227
263
|
|
|
228
|
-
|
|
|
229
|
-
|
|
230
|
-
| <img src="docs/images/several-persons-with-research-outputs.jpg"
|
|
264
|
+
| several persons with several research outputs | one person with several identifiers and research outputs |
|
|
265
|
+
|:----------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------:|
|
|
266
|
+
| <img alt="Several persons with several research outputs." src="docs/images/several-persons-with-research-outputs.jpg" width="40%"> | <img alt="One person with several identifiers and research outputs." src="docs/images/identifiers-and-outputs.jpg" width="50%"> |
|
|
231
267
|
|
|
232
268
|
The left part of this figure shows several persons having several research outputs
|
|
233
269
|
(the symbols) and
|
|
@@ -238,7 +274,7 @@ The right part shows one person having several identifiers and several research
|
|
|
238
274
|
This person has two different ORCIDs, one ISNI, one SCOPUS_AUTHOR_ID, and two FULL_NAMEs (which differ
|
|
239
275
|
in spelling). These identifiers have also been obtained from different source systems, as their color indicates.
|
|
240
276
|
|
|
241
|
-
More examples can be found in [Ricgraph details](docs/ricgraph_details.md).
|
|
277
|
+
More examples can be found in [Ricgraph details](docs/ricgraph_details.md#implementation-details).
|
|
242
278
|
|
|
243
279
|
## Ricgraph in bullet points
|
|
244
280
|
|
|
@@ -246,7 +282,7 @@ More examples can be found in [Ricgraph details](docs/ricgraph_details.md).
|
|
|
246
282
|
refer to. To access an object, a node has a link to that object in
|
|
247
283
|
the system it was obtained from.
|
|
248
284
|
* We have chosen a
|
|
249
|
-
graph as a
|
|
285
|
+
graph as a data structure, since it is a logical and efficient
|
|
250
286
|
method to access objects
|
|
251
287
|
which are close to objects they have a relation to. For example,
|
|
252
288
|
starting with a person, its research outputs are only one
|
|
@@ -297,22 +333,25 @@ More examples can be found in [Ricgraph details](docs/ricgraph_details.md).
|
|
|
297
333
|
|
|
298
334
|
## Next steps
|
|
299
335
|
|
|
300
|
-
[Table of contents of Ricgraph documentation](docs/ricgraph_toc_documentation.md) and
|
|
301
|
-
[Index of Ricgraph documentation](docs/ricgraph_index_documentation.md).
|
|
336
|
+
[Table of contents of Ricgraph documentation](docs/ricgraph_toc_documentation.md#table-of-contents-ricgraph-documentation) and
|
|
337
|
+
[Index of Ricgraph documentation](docs/ricgraph_index_documentation.md#index-ricgraph-documentation).
|
|
302
338
|
|
|
303
339
|
### Further information about Ricgraph
|
|
340
|
+
|
|
341
|
+
* Read the full documentation of Ricgraph on
|
|
342
|
+
[https://docs.ricgraph.eu](https://docs.ricgraph.eu).
|
|
304
343
|
* For a gentle introduction in Ricgraph, read the reference publication:
|
|
305
344
|
Rik D.T. Janssen (2024). Ricgraph: A flexible and extensible graph to explore research in
|
|
306
345
|
context from various systems. *SoftwareX*, 26(101736).
|
|
307
|
-
https://doi.org/10.1016/j.softx.2024.101736.
|
|
346
|
+
[https://doi.org/10.1016/j.softx.2024.101736](https://doi.org/10.1016/j.softx.2024.101736).
|
|
308
347
|
* For a further introduction, you might want to read these two presentations:
|
|
309
348
|
* A general presentation about Ricgraph, presenting Ricgraph in a visual manner:
|
|
310
|
-
https://doi.org/10.5281/zenodo.12634234.
|
|
349
|
+
[https://doi.org/10.5281/zenodo.12634234](https://doi.org/10.5281/zenodo.12634234).
|
|
311
350
|
* A presentation explaining how to enrich
|
|
312
351
|
the [Research Information System Pure](https://www.elsevier.com/solutions/pure)
|
|
313
352
|
(and other source systems) using Ricgraph
|
|
314
353
|
and [BackToPure](https://github.com/UtrechtUniversity/BackToPure):
|
|
315
|
-
https://doi.org/10.5281/zenodo.12634658.
|
|
354
|
+
[https://doi.org/10.5281/zenodo.12634658](https://doi.org/10.5281/zenodo.12634658).
|
|
316
355
|
This presentation explains that after harvesting several Pure systems
|
|
317
356
|
(from different institutions) and other source systems,
|
|
318
357
|
such as [OpenAlex](https://openalex.org),
|
|
@@ -324,45 +363,45 @@ More examples can be found in [Ricgraph details](docs/ricgraph_details.md).
|
|
|
324
363
|
[presentations](docs/ricgraph_pubs_pres_news_use_ment.md#ricgraph-presentations),
|
|
325
364
|
[newsletters](docs/ricgraph_pubs_pres_news_use_ment.md#ricgraph-newsletters)
|
|
326
365
|
(to subscribe, go to [Ricgraph Contact](#contact)),
|
|
366
|
+
[projects with students](docs/ricgraph_pubs_pres_news_use_ment.md#ricgraph-projects-with-students),
|
|
327
367
|
[use](docs/ricgraph_pubs_pres_news_use_ment.md#ricgraph-use), and
|
|
328
368
|
[mentions](docs/ricgraph_pubs_pres_news_use_ment.md#ricgraph-mentions)
|
|
329
369
|
of Ricgraph.
|
|
330
|
-
* Look at the [videos we have made to demonstrate Ricgraph](docs/ricgraph_example_use_videos.md).
|
|
331
|
-
* Read more about [Ricgraph details](docs/ricgraph_details.md),
|
|
370
|
+
* Look at the [videos we have made to demonstrate Ricgraph](docs/ricgraph_example_use_videos.md#ricgraph-videos).
|
|
371
|
+
* Read more about [Ricgraph details](docs/ricgraph_details.md#implementation-details),
|
|
332
372
|
such as example graphs, person identifiers and the *person-root* node.
|
|
333
|
-
* You might want to [compare Ricgraph to other systems](docs/ricgraph_comparison.md).
|
|
373
|
+
* You might want to [compare Ricgraph to other systems](docs/ricgraph_comparison.md#ricgraph-comparison).
|
|
334
374
|
|
|
335
375
|
### Steps to take if you would like to install Ricgraph and harvest data
|
|
336
|
-
|
|
337
|
-
*
|
|
376
|
+
|
|
377
|
+
* [Install and configure Ricgraph](docs/ricgraph_install_configure.md#install-and-configure-ricgraph).
|
|
378
|
+
* Start harvesting data, see [Ricgraph harvest scripts](docs/ricgraph_harvest_scripts.md#ricgraph-harvest-scripts),
|
|
338
379
|
e.g. by doing a harvest for Utrecht University data sets and
|
|
339
380
|
software.
|
|
340
381
|
You will observe that the information from two sources is neatly combined into one graph.
|
|
341
|
-
* Unfortunately, there is a bug, see [known bugs](docs/ricgraph_known_bugs.md).
|
|
382
|
+
* Unfortunately, there is a bug, see [known bugs](docs/ricgraph_known_bugs.md#ricgraph-known-bugs).
|
|
342
383
|
This bug may occur
|
|
343
384
|
if you start a harvest script, and as first step in the script you want to empty Ricgraph.
|
|
344
385
|
In that case, a Python error might occur while emptying Ricgraph. Follow the link
|
|
345
386
|
to read more and find out how to repair that.
|
|
346
387
|
|
|
347
388
|
### Steps to take if you would like to use Ricgraph
|
|
389
|
+
|
|
348
390
|
* First, install Ricgraph (see above).
|
|
349
|
-
* Use [Ricgraph Explorer](docs/ricgraph_explorer.md),
|
|
391
|
+
* Use [Ricgraph Explorer](docs/ricgraph_explorer.md#ricgraph-explorer),
|
|
350
392
|
the exploration tool for Ricgraph.
|
|
351
|
-
* Use the [Ricgraph REST API](docs/ricgraph_restapi.md),
|
|
393
|
+
* Use the [Ricgraph REST API](docs/ricgraph_restapi.md#ricgraph-rest-api),
|
|
352
394
|
the REST API for Ricgraph.
|
|
353
|
-
* Alternatively, you might want to read
|
|
354
|
-
[Query and visualize Ricgraph](docs/ricgraph_query_visualize.md).
|
|
355
395
|
|
|
356
396
|
### Read this in case you would like to extend Ricgraph
|
|
357
|
-
|
|
358
|
-
*
|
|
359
|
-
if you'd like to help.
|
|
397
|
+
|
|
398
|
+
* Start writing scripts, see [Ricgraph script writing](docs/ricgraph_script_writing.md#ricgraph-script-writing).
|
|
360
399
|
|
|
361
400
|
### Ricgraph website
|
|
362
401
|
Ricgraph has a main Ricgraph website on www.ricgraph.eu.
|
|
363
402
|
Alternative sites are www.ricgraph.nl and www.ricgraph.com.
|
|
364
403
|
The sources for this website are on GitHub in repository
|
|
365
|
-
https://github.com/UtrechtUniversity/ricgraph-website.
|
|
404
|
+
[https://github.com/UtrechtUniversity/ricgraph-website](https://github.com/UtrechtUniversity/ricgraph-website).
|
|
366
405
|
|
|
367
406
|
## Contact
|
|
368
407
|
Ricgraph has been created and is being maintained by
|
|
@@ -381,3 +420,8 @@ We also have a
|
|
|
381
420
|
If you like Ricgraph, please give it a GitHub Star by clicking on the top right
|
|
382
421
|
*Star* button on this page. If you have any suggestions or improvements,
|
|
383
422
|
please let me know by creating a GitHub *Issue* at the top left of this page.
|
|
423
|
+
|
|
424
|
+
<!-- Do not change the lines below. The version number will be
|
|
425
|
+
modified by script maintenance/update_version.bash -->
|
|
426
|
+
This README.md file is part of the
|
|
427
|
+
documentation for version 2.10 of Ricgraph - Research in context graph.
|
|
@@ -7,7 +7,7 @@ packages = ["ricgraph"]
|
|
|
7
7
|
|
|
8
8
|
[project]
|
|
9
9
|
name = "ricgraph"
|
|
10
|
-
version = "2.
|
|
10
|
+
version = "2.10"
|
|
11
11
|
authors = [
|
|
12
12
|
{ name="Rik D.T. Janssen" },
|
|
13
13
|
]
|
|
@@ -20,9 +20,11 @@ classifiers = [
|
|
|
20
20
|
"Operating System :: OS Independent",
|
|
21
21
|
"Programming Language :: Python :: 3",
|
|
22
22
|
]
|
|
23
|
-
keywords = ["
|
|
24
|
-
|
|
25
|
-
|
|
23
|
+
keywords = ["Research in context graph", "Ricgraph", "Ricgraph Explorer",
|
|
24
|
+
"Ricgraph REST API", "Data enrichment", "Data harvesting",
|
|
25
|
+
"Data linking", "Enrichment", "Graph", "Graph database",
|
|
26
|
+
"Harvest", "Harvest data", "Harvester", "Knowledge graph",
|
|
27
|
+
"Linked data", "Metadata", "Utrecht University", "Visualization"]
|
|
26
28
|
dependencies = [
|
|
27
29
|
"neo4j >= 5.8",
|
|
28
30
|
"numpy",
|
|
@@ -32,7 +34,7 @@ dependencies = [
|
|
|
32
34
|
|
|
33
35
|
[project.urls]
|
|
34
36
|
Website = "https://www.ricgraph.eu"
|
|
35
|
-
Documentation = "https://
|
|
37
|
+
Documentation = "https://docs.ricgraph.eu"
|
|
36
38
|
GitHub = "https://github.com/UtrechtUniversity/ricgraph"
|
|
37
39
|
Issues = "https://github.com/UtrechtUniversity/ricgraph/issues"
|
|
38
40
|
Download = "https://github.com/UtrechtUniversity/ricgraph/releases"
|
|
@@ -123,7 +123,7 @@ __package__ = 'Ricgraph'
|
|
|
123
123
|
# __version__ should be placed here instead of in __init__.py.
|
|
124
124
|
# If not here, it cannot be found when executing something like
|
|
125
125
|
# PYTHONPATH=../ricgraph ../bin/python ricgraph_explorer.py
|
|
126
|
-
__version__ = '2.
|
|
126
|
+
__version__ = '2.10'
|
|
127
127
|
|
|
128
128
|
|
|
129
129
|
# ########################################################################
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ricgraph
|
|
3
|
+
Version: 2.10
|
|
4
|
+
Summary: Ricgraph - Research in context graph
|
|
5
|
+
Author: Rik D.T. Janssen
|
|
6
|
+
Project-URL: Website, https://www.ricgraph.eu
|
|
7
|
+
Project-URL: Documentation, https://docs.ricgraph.eu
|
|
8
|
+
Project-URL: GitHub, https://github.com/UtrechtUniversity/ricgraph
|
|
9
|
+
Project-URL: Issues, https://github.com/UtrechtUniversity/ricgraph/issues
|
|
10
|
+
Project-URL: Download, https://github.com/UtrechtUniversity/ricgraph/releases
|
|
11
|
+
Project-URL: Release Notes, https://github.com/UtrechtUniversity/ricgraph/releases
|
|
12
|
+
Keywords: Research in context graph,Ricgraph,Ricgraph Explorer,Ricgraph REST API,Data enrichment,Data harvesting,Data linking,Enrichment,Graph,Graph database,Harvest,Harvest data,Harvester,Knowledge graph,Linked data,Metadata,Utrecht University,Visualization
|
|
13
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Requires-Python: >=3.9
|
|
18
|
+
Description-Content-Type: text/markdown
|
|
19
|
+
License-File: LICENSE
|
|
20
|
+
Requires-Dist: neo4j>=5.8
|
|
21
|
+
Requires-Dist: numpy
|
|
22
|
+
Requires-Dist: pandas
|
|
23
|
+
Requires-Dist: requests
|
|
24
|
+
Dynamic: license-file
|
|
25
|
+
|
|
26
|
+
[](https://doi.org/10.5281/zenodo.7524314)
|
|
27
|
+
[](https://doi.org/10.1016/j.softx.2024.101736)
|
|
28
|
+
[](https://www.ricgraph.eu)
|
|
29
|
+
[](https://docs.ricgraph.eu)
|
|
30
|
+
[](https://github.com/UtrechtUniversity/ricgraph)
|
|
31
|
+
|
|
32
|
+
[](https://github.com/UtrechtUniversity/ricgraph/releases)
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
[](https://pypi.org/project/ricgraph)
|
|
36
|
+
[](https://pypistats.org/packages/ricgraph)
|
|
37
|
+
[](LICENSE)
|
|
38
|
+
|
|
39
|
+
<!---
|
|
40
|
+
Note, some lines above end in two spaces, to force a line break but not a paragraph break.
|
|
41
|
+
We use color=#4c1 (green), that color is used by the 'repo status' badge.
|
|
42
|
+
Documentation about the Podman badges can be found here: https://github.com/eggplants/ghcr-badge.
|
|
43
|
+
--->
|
|
44
|
+
|
|
45
|
+
<img alt="Ricgraph logo" src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/refs/heads/main/docs/images/ricgraph_logo.png" width="30%">
|
|
46
|
+
|
|
47
|
+
# Ricgraph - Research in context graph
|
|
48
|
+
|
|
49
|
+
## What is Ricgraph?
|
|
50
|
+
|
|
51
|
+
Ricgraph, also known as Research in context graph, enables the exploration of researchers,
|
|
52
|
+
teams, their results,
|
|
53
|
+
collaborations, skills, projects, and the relations between these items.
|
|
54
|
+
|
|
55
|
+
Ricgraph can store many types of items into a single graph.
|
|
56
|
+
These items can be obtained from various systems and from
|
|
57
|
+
multiple organizations. Ricgraph facilitates reasoning about these
|
|
58
|
+
items because it infers new relations between items,
|
|
59
|
+
relations that are not present in any of the separate source systems.
|
|
60
|
+
It is flexible and extensible, and can be
|
|
61
|
+
adapted to new application areas.
|
|
62
|
+
|
|
63
|
+
## Motivation
|
|
64
|
+
|
|
65
|
+
Ricgraph is software that is about
|
|
66
|
+
relations between items. These items can be collected from various source
|
|
67
|
+
systems and from multiple organizations. We
|
|
68
|
+
explain how Ricgraph works by applying it to the application area
|
|
69
|
+
*research information*. We show the insights that can be
|
|
70
|
+
obtained by combining information from various source systems,
|
|
71
|
+
insight arising from new relations that are not present
|
|
72
|
+
in each separate source system.
|
|
73
|
+
|
|
74
|
+
*Research information* is about anything related to research: research
|
|
75
|
+
results, the persons in a research team, their
|
|
76
|
+
collaborations, their skills, projects in which they have
|
|
77
|
+
participated, as well as the relations between these entities.
|
|
78
|
+
Examples of *research results* are publications, data sets, and software.
|
|
79
|
+
|
|
80
|
+
The following sections show three use cases
|
|
81
|
+
that use different types of information (called *items*):
|
|
82
|
+
researchers, skills, publications,
|
|
83
|
+
etc. Most often, these types of information are not stored in
|
|
84
|
+
one system, so the use cases may be difficult or
|
|
85
|
+
time-consuming to answer. However, by using Ricgraph, these
|
|
86
|
+
use cases (and many others) are easy to answer, as will be
|
|
87
|
+
explained throughout this documentation.
|
|
88
|
+
|
|
89
|
+
Although this documentation illustrates Ricgraph in the application area
|
|
90
|
+
research information, the principle “relations
|
|
91
|
+
between items from various source systems” is general,
|
|
92
|
+
so Ricgraph can be used in other application areas.
|
|
93
|
+
|
|
94
|
+
### Use case for a journalist
|
|
95
|
+
As a journalist, I want to find researchers with a certain skill S and their publications,
|
|
96
|
+
so that I can interview them for a newspaper article.
|
|
97
|
+
Example skills can be: *climate change* or *stem cells*.
|
|
98
|
+
The items surrounded by the red line are the solution to this use case.
|
|
99
|
+
|
|
100
|
+
<!--
|
|
101
|
+
The 'width=...' in the lines below to include a figure are necessary for
|
|
102
|
+
the documentation generated with Quarto, a.o. for the documentation website.
|
|
103
|
+
We will need a width instead of a height to prevent right margin overflows
|
|
104
|
+
on small mobile screens.
|
|
105
|
+
-->
|
|
106
|
+
|
|
107
|
+
<img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/journalist-use-case.jpg" alt="Ricgraph use case for a journalist." width="70%">
|
|
108
|
+
|
|
109
|
+
### Use case for a librarian
|
|
110
|
+
As a librarian, I want to enrich my local research information system with research results
|
|
111
|
+
from person A that are in other systems (in orange, *RIS2*) but not in
|
|
112
|
+
ours (in green, *RIS1*), so that we have a more complete view of research at our university.
|
|
113
|
+
The items surrounded by the red line are the solution to this use case.
|
|
114
|
+
|
|
115
|
+
<img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/librarian-use-case.jpg" alt="Ricgraph use case for a librarian." width="75%">
|
|
116
|
+
|
|
117
|
+
### Use case for a researcher
|
|
118
|
+
As a researcher A, I want to find researchers from other universities that have
|
|
119
|
+
co-authored publications written by the co-authors of my own publications,
|
|
120
|
+
so that I can read their publications to find out if we share common research interests.
|
|
121
|
+
The items surrounded by the red line are the solution to this use case.
|
|
122
|
+
|
|
123
|
+
<img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/researcher-use-case.jpg" alt="Ricgraph use case for a researcher." width="35%">
|
|
124
|
+
|
|
125
|
+
### Main contributions of Ricgraph
|
|
126
|
+
|
|
127
|
+
* Ricgraph can store many types of items in a single graph.
|
|
128
|
+
* Ricgraph harvests multiple source systems into a single graph.
|
|
129
|
+
* Ricgraph Explorer is the exploration tool for Ricgraph.
|
|
130
|
+
* Ricgraph facilitates reasoning about items because it infers new relations between items.
|
|
131
|
+
* Ricgraph can be tailored for an application area.
|
|
132
|
+
|
|
133
|
+
### Read more about Ricgraph
|
|
134
|
+
|
|
135
|
+
For a gentle introduction in Ricgraph, read the reference publication:
|
|
136
|
+
Rik D.T. Janssen (2024). Ricgraph: A flexible and extensible graph to explore research in
|
|
137
|
+
context from various systems. *SoftwareX*, 26(101736).
|
|
138
|
+
[https://doi.org/10.1016/j.softx.2024.101736](https://doi.org/10.1016/j.softx.2024.101736).
|
|
139
|
+
|
|
140
|
+
You might also want to read the documentation on
|
|
141
|
+
[https://docs.ricgraph.eu](https://docs.ricgraph.eu).
|
|
142
|
+
You can also go to the [Ricgraph GitHub repository](https://github.com/UtrechtUniversity/ricgraph).
|
|
143
|
+
To use Ricgraph, installing the [Ricgraph package from PyPI](https://pypi.org/project/ricgraph)
|
|
144
|
+
is not sufficient. Please read the
|
|
145
|
+
installation instructions in the Ricgraph GitHub repository.
|
|
146
|
+
|
ricgraph-2.9/PKG-INFO
DELETED
|
@@ -1,125 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.2
|
|
2
|
-
Name: ricgraph
|
|
3
|
-
Version: 2.9
|
|
4
|
-
Summary: Ricgraph - Research in context graph
|
|
5
|
-
Author: Rik D.T. Janssen
|
|
6
|
-
Project-URL: Website, https://www.ricgraph.eu
|
|
7
|
-
Project-URL: Documentation, https://github.com/UtrechtUniversity/ricgraph/blob/main/README.md
|
|
8
|
-
Project-URL: GitHub, https://github.com/UtrechtUniversity/ricgraph
|
|
9
|
-
Project-URL: Issues, https://github.com/UtrechtUniversity/ricgraph/issues
|
|
10
|
-
Project-URL: Download, https://github.com/UtrechtUniversity/ricgraph/releases
|
|
11
|
-
Project-URL: Release Notes, https://github.com/UtrechtUniversity/ricgraph/releases
|
|
12
|
-
Keywords: Ricgraph,Ricgraph Explorer,Ricgraph REST API,Research in context graph,Graph,Graph database,Data harvesting,Data enrichment,Data linking,Linked data,Knowledge graph,Metadata,Utrecht University
|
|
13
|
-
Classifier: Development Status :: 5 - Production/Stable
|
|
14
|
-
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
-
Classifier: Operating System :: OS Independent
|
|
16
|
-
Classifier: Programming Language :: Python :: 3
|
|
17
|
-
Requires-Python: >=3.9
|
|
18
|
-
Description-Content-Type: text/markdown
|
|
19
|
-
License-File: LICENSE
|
|
20
|
-
Requires-Dist: neo4j>=5.8
|
|
21
|
-
Requires-Dist: numpy
|
|
22
|
-
Requires-Dist: pandas
|
|
23
|
-
Requires-Dist: requests
|
|
24
|
-
|
|
25
|
-
[](https://doi.org/10.5281/zenodo.7524314)
|
|
26
|
-
[](https://doi.org/10.1016/j.softx.2024.101736)
|
|
27
|
-
[](https://www.ricgraph.eu)
|
|
28
|
-
|
|
29
|
-
[](https://github.com/UtrechtUniversity/ricgraph/releases)
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
[](https://pypi.org/project/ricgraph)
|
|
33
|
-
[](https://pypistats.org/packages/ricgraph)
|
|
34
|
-
[](https://github.com/UtrechtUniversity/ricgraph/blob/main/docs/ricgraph_containerized.md)
|
|
35
|
-
[](https://github.com/utrechtuniversity/ricgraph/pkgs/container/ricgraph)
|
|
36
|
-
[](LICENSE)
|
|
37
|
-
[](https://www.repostatus.org/#active)
|
|
38
|
-
[](https://github.com/CLARIAH/clariah-plus/blob/main/requirements/software-metadata-requirements.md#15--you-should-express-a-technology-readiness-level)
|
|
39
|
-
[](https://fairsoftwarechecklist.net/v0.2?f=31&a=32113&i=32110&r=123)
|
|
40
|
-
|
|
41
|
-
<!---
|
|
42
|
-
Note, the lines 'Website' and
|
|
43
|
-
'PyPI downloads' end in two spaces, to force a line break but not a paragraph break.
|
|
44
|
-
Similar for others.
|
|
45
|
-
We use color=#4c1 (green), that color is used by the 'repo status' badge.
|
|
46
|
-
Documentation about the Podman badges can be found here: https://github.com/eggplants/ghcr-badge.
|
|
47
|
-
--->
|
|
48
|
-
|
|
49
|
-
<img alt="Ricgraph logo" src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/refs/heads/main/docs/images/ricgraph_logo.png" height="30">
|
|
50
|
-
|
|
51
|
-
# Ricgraph - Research in context graph
|
|
52
|
-
|
|
53
|
-
## What is Ricgraph?
|
|
54
|
-
|
|
55
|
-
Ricgraph, also known as Research in context graph, enables the exploration of researchers,
|
|
56
|
-
teams, their results,
|
|
57
|
-
collaborations, skills, projects, and the relations between these items.
|
|
58
|
-
|
|
59
|
-
Ricgraph can store many types of items into a single graph.
|
|
60
|
-
These items can be obtained from various systems and from
|
|
61
|
-
multiple organizations. Ricgraph facilitates reasoning about these
|
|
62
|
-
items because it infers new relations between items,
|
|
63
|
-
relations that are not present in any of the separate source systems.
|
|
64
|
-
It is flexible and extensible, and can be
|
|
65
|
-
adapted to new application areas.
|
|
66
|
-
|
|
67
|
-
### Motivation
|
|
68
|
-
|
|
69
|
-
Ricgraph, also known as Research in context graph, is software that is about
|
|
70
|
-
relations between items. These items can be collected from various source
|
|
71
|
-
systems and from multiple organizations. We
|
|
72
|
-
explain how Ricgraph works by applying it to the application area
|
|
73
|
-
*research information*. We show the insights that can be
|
|
74
|
-
obtained by combining information from various source systems,
|
|
75
|
-
insight arising from new relations that are not present
|
|
76
|
-
in each separate source system.
|
|
77
|
-
|
|
78
|
-
*Research information* is about anything related to research: research
|
|
79
|
-
results, the persons in a research team, their
|
|
80
|
-
collaborations, their skills, projects in which they have
|
|
81
|
-
participated, as well as the relations between these entities.
|
|
82
|
-
Examples of *research results* are publications, data sets, and software.
|
|
83
|
-
|
|
84
|
-
Example use cases from the application area research information are:
|
|
85
|
-
|
|
86
|
-
| Use case | In Ricgraph |
|
|
87
|
-
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
|
|
88
|
-
| As a journalist, I want to find researchers with a certain skill S and their publications, so that I can interview them for a newspaper article. Example skills can be: *climate change* or *stem cells*. | <img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/journalist-use-case.jpg" width="700"> |
|
|
89
|
-
| As a librarian, I want to enrich my local research information system with research results from person A that are in other systems (in orange, *RIS2*) but not in ours (in green, *RIS1*), so that we have a more complete view of research at our university. | <img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/librarian-use-case.jpg" width="700"> |
|
|
90
|
-
| As a researcher A, I want to find researchers from other universities that have co-authored publications written by the co-authors of my own publications, so that I can read their publications to find out if we share common research interests. | <img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/researcher-use-case.jpg" width="700"> |
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
These use cases use different types of information (called *items*):
|
|
94
|
-
researchers, skills, publications,
|
|
95
|
-
etc. Most often, these types of information are not stored in
|
|
96
|
-
one system, so the use cases may be difficult or
|
|
97
|
-
time-consuming to answer. However, by using Ricgraph, these
|
|
98
|
-
use cases (and many others) are easy to answer, as will be
|
|
99
|
-
explained throughout this documentation.
|
|
100
|
-
|
|
101
|
-
Although this documentation illustrates Ricgraph in the application area
|
|
102
|
-
research information, the principle “relations
|
|
103
|
-
between items from various source systems” is general,
|
|
104
|
-
so Ricgraph can be used in other application areas.
|
|
105
|
-
|
|
106
|
-
### Main contributions of Ricgraph
|
|
107
|
-
|
|
108
|
-
* Ricgraph can store many types of items in a single graph.
|
|
109
|
-
* Ricgraph harvests multiple source systems into a single graph.
|
|
110
|
-
* Ricgraph Explorer is the exploration tool for Ricgraph.
|
|
111
|
-
* Ricgraph facilitates reasoning about items because it infers new relations between items.
|
|
112
|
-
* Ricgraph can be tailored for an application area.
|
|
113
|
-
|
|
114
|
-
### Read more about Ricgraph
|
|
115
|
-
|
|
116
|
-
For a gentle introduction in Ricgraph, read the reference publication:
|
|
117
|
-
Rik D.T. Janssen (2024). Ricgraph: A flexible and extensible graph to explore research in
|
|
118
|
-
context from various systems. *SoftwareX*, 26(101736).
|
|
119
|
-
https://doi.org/10.1016/j.softx.2024.101736.
|
|
120
|
-
|
|
121
|
-
You might also want to read the documentation in
|
|
122
|
-
the [Ricgraph GitHub repository](https://github.com/UtrechtUniversity/ricgraph).
|
|
123
|
-
To use Ricgraph, installing the [Ricgraph package from PyPI](https://pypi.org/project/ricgraph)
|
|
124
|
-
is not sufficient. Please read the
|
|
125
|
-
installation instructions in the Ricgraph GitHub repository.
|
ricgraph-2.9/README-PyPI.md
DELETED
|
@@ -1,101 +0,0 @@
|
|
|
1
|
-
[](https://doi.org/10.5281/zenodo.7524314)
|
|
2
|
-
[](https://doi.org/10.1016/j.softx.2024.101736)
|
|
3
|
-
[](https://www.ricgraph.eu)
|
|
4
|
-
|
|
5
|
-
[](https://github.com/UtrechtUniversity/ricgraph/releases)
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
[](https://pypi.org/project/ricgraph)
|
|
9
|
-
[](https://pypistats.org/packages/ricgraph)
|
|
10
|
-
[](https://github.com/UtrechtUniversity/ricgraph/blob/main/docs/ricgraph_containerized.md)
|
|
11
|
-
[](https://github.com/utrechtuniversity/ricgraph/pkgs/container/ricgraph)
|
|
12
|
-
[](LICENSE)
|
|
13
|
-
[](https://www.repostatus.org/#active)
|
|
14
|
-
[](https://github.com/CLARIAH/clariah-plus/blob/main/requirements/software-metadata-requirements.md#15--you-should-express-a-technology-readiness-level)
|
|
15
|
-
[](https://fairsoftwarechecklist.net/v0.2?f=31&a=32113&i=32110&r=123)
|
|
16
|
-
|
|
17
|
-
<!---
|
|
18
|
-
Note, the lines 'Website' and
|
|
19
|
-
'PyPI downloads' end in two spaces, to force a line break but not a paragraph break.
|
|
20
|
-
Similar for others.
|
|
21
|
-
We use color=#4c1 (green), that color is used by the 'repo status' badge.
|
|
22
|
-
Documentation about the Podman badges can be found here: https://github.com/eggplants/ghcr-badge.
|
|
23
|
-
--->
|
|
24
|
-
|
|
25
|
-
<img alt="Ricgraph logo" src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/refs/heads/main/docs/images/ricgraph_logo.png" height="30">
|
|
26
|
-
|
|
27
|
-
# Ricgraph - Research in context graph
|
|
28
|
-
|
|
29
|
-
## What is Ricgraph?
|
|
30
|
-
|
|
31
|
-
Ricgraph, also known as Research in context graph, enables the exploration of researchers,
|
|
32
|
-
teams, their results,
|
|
33
|
-
collaborations, skills, projects, and the relations between these items.
|
|
34
|
-
|
|
35
|
-
Ricgraph can store many types of items into a single graph.
|
|
36
|
-
These items can be obtained from various systems and from
|
|
37
|
-
multiple organizations. Ricgraph facilitates reasoning about these
|
|
38
|
-
items because it infers new relations between items,
|
|
39
|
-
relations that are not present in any of the separate source systems.
|
|
40
|
-
It is flexible and extensible, and can be
|
|
41
|
-
adapted to new application areas.
|
|
42
|
-
|
|
43
|
-
### Motivation
|
|
44
|
-
|
|
45
|
-
Ricgraph, also known as Research in context graph, is software that is about
|
|
46
|
-
relations between items. These items can be collected from various source
|
|
47
|
-
systems and from multiple organizations. We
|
|
48
|
-
explain how Ricgraph works by applying it to the application area
|
|
49
|
-
*research information*. We show the insights that can be
|
|
50
|
-
obtained by combining information from various source systems,
|
|
51
|
-
insight arising from new relations that are not present
|
|
52
|
-
in each separate source system.
|
|
53
|
-
|
|
54
|
-
*Research information* is about anything related to research: research
|
|
55
|
-
results, the persons in a research team, their
|
|
56
|
-
collaborations, their skills, projects in which they have
|
|
57
|
-
participated, as well as the relations between these entities.
|
|
58
|
-
Examples of *research results* are publications, data sets, and software.
|
|
59
|
-
|
|
60
|
-
Example use cases from the application area research information are:
|
|
61
|
-
|
|
62
|
-
| Use case | In Ricgraph |
|
|
63
|
-
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
|
|
64
|
-
| As a journalist, I want to find researchers with a certain skill S and their publications, so that I can interview them for a newspaper article. Example skills can be: *climate change* or *stem cells*. | <img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/journalist-use-case.jpg" width="700"> |
|
|
65
|
-
| As a librarian, I want to enrich my local research information system with research results from person A that are in other systems (in orange, *RIS2*) but not in ours (in green, *RIS1*), so that we have a more complete view of research at our university. | <img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/librarian-use-case.jpg" width="700"> |
|
|
66
|
-
| As a researcher A, I want to find researchers from other universities that have co-authored publications written by the co-authors of my own publications, so that I can read their publications to find out if we share common research interests. | <img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/researcher-use-case.jpg" width="700"> |
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
These use cases use different types of information (called *items*):
|
|
70
|
-
researchers, skills, publications,
|
|
71
|
-
etc. Most often, these types of information are not stored in
|
|
72
|
-
one system, so the use cases may be difficult or
|
|
73
|
-
time-consuming to answer. However, by using Ricgraph, these
|
|
74
|
-
use cases (and many others) are easy to answer, as will be
|
|
75
|
-
explained throughout this documentation.
|
|
76
|
-
|
|
77
|
-
Although this documentation illustrates Ricgraph in the application area
|
|
78
|
-
research information, the principle “relations
|
|
79
|
-
between items from various source systems” is general,
|
|
80
|
-
so Ricgraph can be used in other application areas.
|
|
81
|
-
|
|
82
|
-
### Main contributions of Ricgraph
|
|
83
|
-
|
|
84
|
-
* Ricgraph can store many types of items in a single graph.
|
|
85
|
-
* Ricgraph harvests multiple source systems into a single graph.
|
|
86
|
-
* Ricgraph Explorer is the exploration tool for Ricgraph.
|
|
87
|
-
* Ricgraph facilitates reasoning about items because it infers new relations between items.
|
|
88
|
-
* Ricgraph can be tailored for an application area.
|
|
89
|
-
|
|
90
|
-
### Read more about Ricgraph
|
|
91
|
-
|
|
92
|
-
For a gentle introduction in Ricgraph, read the reference publication:
|
|
93
|
-
Rik D.T. Janssen (2024). Ricgraph: A flexible and extensible graph to explore research in
|
|
94
|
-
context from various systems. *SoftwareX*, 26(101736).
|
|
95
|
-
https://doi.org/10.1016/j.softx.2024.101736.
|
|
96
|
-
|
|
97
|
-
You might also want to read the documentation in
|
|
98
|
-
the [Ricgraph GitHub repository](https://github.com/UtrechtUniversity/ricgraph).
|
|
99
|
-
To use Ricgraph, installing the [Ricgraph package from PyPI](https://pypi.org/project/ricgraph)
|
|
100
|
-
is not sufficient. Please read the
|
|
101
|
-
installation instructions in the Ricgraph GitHub repository.
|
|
@@ -1,125 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.2
|
|
2
|
-
Name: ricgraph
|
|
3
|
-
Version: 2.9
|
|
4
|
-
Summary: Ricgraph - Research in context graph
|
|
5
|
-
Author: Rik D.T. Janssen
|
|
6
|
-
Project-URL: Website, https://www.ricgraph.eu
|
|
7
|
-
Project-URL: Documentation, https://github.com/UtrechtUniversity/ricgraph/blob/main/README.md
|
|
8
|
-
Project-URL: GitHub, https://github.com/UtrechtUniversity/ricgraph
|
|
9
|
-
Project-URL: Issues, https://github.com/UtrechtUniversity/ricgraph/issues
|
|
10
|
-
Project-URL: Download, https://github.com/UtrechtUniversity/ricgraph/releases
|
|
11
|
-
Project-URL: Release Notes, https://github.com/UtrechtUniversity/ricgraph/releases
|
|
12
|
-
Keywords: Ricgraph,Ricgraph Explorer,Ricgraph REST API,Research in context graph,Graph,Graph database,Data harvesting,Data enrichment,Data linking,Linked data,Knowledge graph,Metadata,Utrecht University
|
|
13
|
-
Classifier: Development Status :: 5 - Production/Stable
|
|
14
|
-
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
-
Classifier: Operating System :: OS Independent
|
|
16
|
-
Classifier: Programming Language :: Python :: 3
|
|
17
|
-
Requires-Python: >=3.9
|
|
18
|
-
Description-Content-Type: text/markdown
|
|
19
|
-
License-File: LICENSE
|
|
20
|
-
Requires-Dist: neo4j>=5.8
|
|
21
|
-
Requires-Dist: numpy
|
|
22
|
-
Requires-Dist: pandas
|
|
23
|
-
Requires-Dist: requests
|
|
24
|
-
|
|
25
|
-
[](https://doi.org/10.5281/zenodo.7524314)
|
|
26
|
-
[](https://doi.org/10.1016/j.softx.2024.101736)
|
|
27
|
-
[](https://www.ricgraph.eu)
|
|
28
|
-
|
|
29
|
-
[](https://github.com/UtrechtUniversity/ricgraph/releases)
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
[](https://pypi.org/project/ricgraph)
|
|
33
|
-
[](https://pypistats.org/packages/ricgraph)
|
|
34
|
-
[](https://github.com/UtrechtUniversity/ricgraph/blob/main/docs/ricgraph_containerized.md)
|
|
35
|
-
[](https://github.com/utrechtuniversity/ricgraph/pkgs/container/ricgraph)
|
|
36
|
-
[](LICENSE)
|
|
37
|
-
[](https://www.repostatus.org/#active)
|
|
38
|
-
[](https://github.com/CLARIAH/clariah-plus/blob/main/requirements/software-metadata-requirements.md#15--you-should-express-a-technology-readiness-level)
|
|
39
|
-
[](https://fairsoftwarechecklist.net/v0.2?f=31&a=32113&i=32110&r=123)
|
|
40
|
-
|
|
41
|
-
<!---
|
|
42
|
-
Note, the lines 'Website' and
|
|
43
|
-
'PyPI downloads' end in two spaces, to force a line break but not a paragraph break.
|
|
44
|
-
Similar for others.
|
|
45
|
-
We use color=#4c1 (green), that color is used by the 'repo status' badge.
|
|
46
|
-
Documentation about the Podman badges can be found here: https://github.com/eggplants/ghcr-badge.
|
|
47
|
-
--->
|
|
48
|
-
|
|
49
|
-
<img alt="Ricgraph logo" src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/refs/heads/main/docs/images/ricgraph_logo.png" height="30">
|
|
50
|
-
|
|
51
|
-
# Ricgraph - Research in context graph
|
|
52
|
-
|
|
53
|
-
## What is Ricgraph?
|
|
54
|
-
|
|
55
|
-
Ricgraph, also known as Research in context graph, enables the exploration of researchers,
|
|
56
|
-
teams, their results,
|
|
57
|
-
collaborations, skills, projects, and the relations between these items.
|
|
58
|
-
|
|
59
|
-
Ricgraph can store many types of items into a single graph.
|
|
60
|
-
These items can be obtained from various systems and from
|
|
61
|
-
multiple organizations. Ricgraph facilitates reasoning about these
|
|
62
|
-
items because it infers new relations between items,
|
|
63
|
-
relations that are not present in any of the separate source systems.
|
|
64
|
-
It is flexible and extensible, and can be
|
|
65
|
-
adapted to new application areas.
|
|
66
|
-
|
|
67
|
-
### Motivation
|
|
68
|
-
|
|
69
|
-
Ricgraph, also known as Research in context graph, is software that is about
|
|
70
|
-
relations between items. These items can be collected from various source
|
|
71
|
-
systems and from multiple organizations. We
|
|
72
|
-
explain how Ricgraph works by applying it to the application area
|
|
73
|
-
*research information*. We show the insights that can be
|
|
74
|
-
obtained by combining information from various source systems,
|
|
75
|
-
insight arising from new relations that are not present
|
|
76
|
-
in each separate source system.
|
|
77
|
-
|
|
78
|
-
*Research information* is about anything related to research: research
|
|
79
|
-
results, the persons in a research team, their
|
|
80
|
-
collaborations, their skills, projects in which they have
|
|
81
|
-
participated, as well as the relations between these entities.
|
|
82
|
-
Examples of *research results* are publications, data sets, and software.
|
|
83
|
-
|
|
84
|
-
Example use cases from the application area research information are:
|
|
85
|
-
|
|
86
|
-
| Use case | In Ricgraph |
|
|
87
|
-
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
|
|
88
|
-
| As a journalist, I want to find researchers with a certain skill S and their publications, so that I can interview them for a newspaper article. Example skills can be: *climate change* or *stem cells*. | <img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/journalist-use-case.jpg" width="700"> |
|
|
89
|
-
| As a librarian, I want to enrich my local research information system with research results from person A that are in other systems (in orange, *RIS2*) but not in ours (in green, *RIS1*), so that we have a more complete view of research at our university. | <img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/librarian-use-case.jpg" width="700"> |
|
|
90
|
-
| As a researcher A, I want to find researchers from other universities that have co-authored publications written by the co-authors of my own publications, so that I can read their publications to find out if we share common research interests. | <img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/main/docs/images/researcher-use-case.jpg" width="700"> |
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
These use cases use different types of information (called *items*):
|
|
94
|
-
researchers, skills, publications,
|
|
95
|
-
etc. Most often, these types of information are not stored in
|
|
96
|
-
one system, so the use cases may be difficult or
|
|
97
|
-
time-consuming to answer. However, by using Ricgraph, these
|
|
98
|
-
use cases (and many others) are easy to answer, as will be
|
|
99
|
-
explained throughout this documentation.
|
|
100
|
-
|
|
101
|
-
Although this documentation illustrates Ricgraph in the application area
|
|
102
|
-
research information, the principle “relations
|
|
103
|
-
between items from various source systems” is general,
|
|
104
|
-
so Ricgraph can be used in other application areas.
|
|
105
|
-
|
|
106
|
-
### Main contributions of Ricgraph
|
|
107
|
-
|
|
108
|
-
* Ricgraph can store many types of items in a single graph.
|
|
109
|
-
* Ricgraph harvests multiple source systems into a single graph.
|
|
110
|
-
* Ricgraph Explorer is the exploration tool for Ricgraph.
|
|
111
|
-
* Ricgraph facilitates reasoning about items because it infers new relations between items.
|
|
112
|
-
* Ricgraph can be tailored for an application area.
|
|
113
|
-
|
|
114
|
-
### Read more about Ricgraph
|
|
115
|
-
|
|
116
|
-
For a gentle introduction in Ricgraph, read the reference publication:
|
|
117
|
-
Rik D.T. Janssen (2024). Ricgraph: A flexible and extensible graph to explore research in
|
|
118
|
-
context from various systems. *SoftwareX*, 26(101736).
|
|
119
|
-
https://doi.org/10.1016/j.softx.2024.101736.
|
|
120
|
-
|
|
121
|
-
You might also want to read the documentation in
|
|
122
|
-
the [Ricgraph GitHub repository](https://github.com/UtrechtUniversity/ricgraph).
|
|
123
|
-
To use Ricgraph, installing the [Ricgraph package from PyPI](https://pypi.org/project/ricgraph)
|
|
124
|
-
is not sufficient. Please read the
|
|
125
|
-
installation instructions in the Ricgraph GitHub repository.
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|