ricgraph 2.8__py3-none-any.whl
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/__init__.py +38 -0
- ricgraph/ricgraph.py +2866 -0
- ricgraph-2.8.dist-info/LICENSE +21 -0
- ricgraph-2.8.dist-info/METADATA +125 -0
- ricgraph-2.8.dist-info/RECORD +7 -0
- ricgraph-2.8.dist-info/WHEEL +5 -0
- ricgraph-2.8.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Rik D.T. Janssen
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
Metadata-Version: 2.2
|
|
2
|
+
Name: ricgraph
|
|
3
|
+
Version: 2.8
|
|
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.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
ricgraph/__init__.py,sha256=q_m7-5xYpi7s_tHta5qI_Pa2BeKEjUM6vlVR66QKNAg,1611
|
|
2
|
+
ricgraph/ricgraph.py,sha256=pfraeO93wzg3QHuQBEl-5MUY1EUYWYRvJp6FjJbFCFU,119146
|
|
3
|
+
ricgraph-2.8.dist-info/LICENSE,sha256=-SvGA6e6z9mmCKXW_i6BuG2oylVAYgkYHo3W5yeQ2XY,1073
|
|
4
|
+
ricgraph-2.8.dist-info/METADATA,sha256=_zmGheDUxiZaFdXCmsN8YzSkv8wPYTs64NpQJhC0OrE,9068
|
|
5
|
+
ricgraph-2.8.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
|
|
6
|
+
ricgraph-2.8.dist-info/top_level.txt,sha256=-S2CIwSfau-lubWEReCtTrqtB9ZmxP9D80rSNZMI2JQ,9
|
|
7
|
+
ricgraph-2.8.dist-info/RECORD,,
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
ricgraph
|