ricgraph 2.9__tar.gz → 2.11__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.11/PKG-INFO +154 -0
- ricgraph-2.11/README-PyPI.md +129 -0
- ricgraph-2.11/README.md +393 -0
- {ricgraph-2.9 → ricgraph-2.11}/pyproject.toml +7 -5
- {ricgraph-2.9 → ricgraph-2.11}/ricgraph/ricgraph.py +46 -17
- ricgraph-2.11/ricgraph.egg-info/PKG-INFO +154 -0
- ricgraph-2.9/PKG-INFO +0 -125
- ricgraph-2.9/README-PyPI.md +0 -101
- ricgraph-2.9/README.md +0 -383
- ricgraph-2.9/ricgraph.egg-info/PKG-INFO +0 -125
- {ricgraph-2.9 → ricgraph-2.11}/LICENSE +0 -0
- {ricgraph-2.9 → ricgraph-2.11}/ricgraph/__init__.py +0 -0
- {ricgraph-2.9 → ricgraph-2.11}/ricgraph.egg-info/SOURCES.txt +0 -0
- {ricgraph-2.9 → ricgraph-2.11}/ricgraph.egg-info/dependency_links.txt +0 -0
- {ricgraph-2.9 → ricgraph-2.11}/ricgraph.egg-info/requires.txt +0 -0
- {ricgraph-2.9 → ricgraph-2.11}/ricgraph.egg-info/top_level.txt +0 -0
- {ricgraph-2.9 → ricgraph-2.11}/setup.cfg +0 -0
ricgraph-2.11/PKG-INFO
ADDED
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ricgraph
|
|
3
|
+
Version: 2.11
|
|
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
|
+
|
|
147
|
+
## Contact
|
|
148
|
+
|
|
149
|
+
Ricgraph has been created and is being maintained by
|
|
150
|
+
Rik D.T. Janssen from Utrecht University in the Netherlands.
|
|
151
|
+
You can find contact details at
|
|
152
|
+
[his Utrecht University employee page](https://www.uu.nl/staff/DTJanssen).
|
|
153
|
+
He also has an ORCID profile on
|
|
154
|
+
[ORCID 0000-0001-9510-0802](https://orcid.org/0000-0001-9510-0802).
|
|
@@ -0,0 +1,129 @@
|
|
|
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
|
+
|
|
122
|
+
## Contact
|
|
123
|
+
|
|
124
|
+
Ricgraph has been created and is being maintained by
|
|
125
|
+
Rik D.T. Janssen from Utrecht University in the Netherlands.
|
|
126
|
+
You can find contact details at
|
|
127
|
+
[his Utrecht University employee page](https://www.uu.nl/staff/DTJanssen).
|
|
128
|
+
He also has an ORCID profile on
|
|
129
|
+
[ORCID 0000-0001-9510-0802](https://orcid.org/0000-0001-9510-0802).
|