Metadata-Version: 2.1
Name: ricgraph
Version: 2.6
Summary: Ricgraph - Research in context graph
Author: Rik D.T. Janssen
Project-URL: Website, https://www.ricgraph.eu
Project-URL: Documentation, https://github.com/UtrechtUniversity/ricgraph/blob/main/README.md
Project-URL: GitHub, https://github.com/UtrechtUniversity/ricgraph
Project-URL: Issues, https://github.com/UtrechtUniversity/ricgraph/issues
Project-URL: Download, https://github.com/UtrechtUniversity/ricgraph/releases
Project-URL: Release Notes, https://github.com/UtrechtUniversity/ricgraph/releases
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
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: connexion[flask,swagger-ui,uvicorn]
Requires-Dist: flask
Requires-Dist: gunicorn
Requires-Dist: markupsafe
Requires-Dist: neo4j >=5.8
Requires-Dist: numpy
Requires-Dist: openapi-markdown
Requires-Dist: pandas
Requires-Dist: pyalex
Requires-Dist: ratelimit
Requires-Dist: requests
Requires-Dist: Sickle
Requires-Dist: xmltodict

[![Static Badge](https://img.shields.io/badge/DOI%20%20software-10.5281/zenodo.7524314-blue)](https://doi.org/10.5281/zenodo.7524314)
[![Static Badge](https://img.shields.io/badge/DOI%20reference%20publication-10.1016%2Fj.softx.2024.101736-blue)](https://doi.org/10.1016/j.softx.2024.101736)
[![Static Badge](https://img.shields.io/badge/Website-www.ricgraph.eu-blue)](https://www.ricgraph.eu)  
![GitHub release date](https://img.shields.io/github/release-date/UtrechtUniversity/ricgraph)
![GitHub latest release](https://img.shields.io/github/release/UtrechtUniversity/ricgraph?color=green)
![GitHub commits since latest release](https://img.shields.io/github/commits-since/UtrechtUniversity/ricgraph/latest?color=green)
![GitHub last commit](https://img.shields.io/github/last-commit/UtrechtUniversity/ricgraph)  
[![GitHub license](https://img.shields.io/github/license/UtrechtUniversity/ricgraph)](LICENSE)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Technology Readiness Level 6/9 - Late Prototype - Technology demonstrated in target setting, end-users adopt it for testing purposes](https://w3id.org/research-technology-readiness-levels/Level6LatePrototype.svg)](https://github.com/CLARIAH/clariah-plus/blob/main/requirements/software-metadata-requirements.md#15--you-should-express-a-technology-readiness-level)
[![FAIR checklist badge](https://fairsoftwarechecklist.net/badge.svg)](https://fairsoftwarechecklist.net/v0.2?f=31&a=32113&i=32110&r=123)
<!---
Note, the lines 'Website' and
'GitHub last commit' end in two spaces, to force a line break but not a paragraph break.
--->
<img src="https://raw.githubusercontent.com/UtrechtUniversity/ricgraph/refs/heads/main/docs/images/ricgraph_logo.jpg" height="30"> 

# Ricgraph - Research in context graph 

## What is Ricgraph?

Ricgraph, also known as Research in context graph, enables the exploration of researchers, 
teams, their results,
collaborations, skills, projects, and the relations between these items.

Ricgraph can store many types of items into a single graph. 
These items can be obtained from various systems and from
multiple organizations. Ricgraph facilitates reasoning about these 
items because it infers new relations between items,
relations that are not present in any of the separate source systems. 
It is flexible and extensible, and can be
adapted to new application areas.

### Motivation

Ricgraph, also known as Research in context graph, is software that is about
relations between items. These items can be collected from various source 
systems and from multiple organizations. We
explain how Ricgraph works by applying it to the application area 
*research information*. We show the insights that can be
obtained by combining information from various source systems, 
insight arising from new relations that are not present
in each separate source system.

*Research information* is about anything related to research: research 
results, the persons in a research team, their
collaborations, their skills, projects in which they have 
participated, as well as the relations between these entities.
Examples of *research results* are publications, data sets, and software.

Example use cases from the application area research information are:

| Use case                                                                                                                                                                                                                                                        | In Ricgraph                                                                                                                   |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
| 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"> |
| 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">  |
| 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"> |


These use cases use different types of information (called *items*):
researchers, skills, publications,
etc. Most often, these types of information are not stored in 
one system, so the use cases may be difficult or
time-consuming to answer. However, by using Ricgraph, these 
use cases (and many others) are easy to answer, as will be
explained throughout this documentation.

Although this documentation illustrates Ricgraph in the application area 
research information, the principle “relations
between items from various source systems” is general, 
so Ricgraph can be used in other application areas.

### Main contributions of Ricgraph

* Ricgraph can store many types of items in a single graph.
* Ricgraph harvests multiple source systems into a single graph.
* Ricgraph Explorer is the exploration tool for Ricgraph.
* Ricgraph facilitates reasoning about items because it infers new relations between items.
* Ricgraph can be tailored for an application area.

### Read more about Ricgraph

For a gentle introduction in Ricgraph, read the reference publication: 
Rik D.T. Janssen (2024). Ricgraph: A flexible and extensible graph to explore research in
context from various systems. *SoftwareX*, 26(101736).
https://doi.org/10.1016/j.softx.2024.101736.

You might also want to read the documentation in 
the [Ricgraph GitHub repository](https://github.com/UtrechtUniversity/ricgraph).
To use Ricgraph, installing the [Ricgraph package from PyPI](https://pypi.org/project/ricgraph) 
is not sufficient. Please read the
installation instructions in the Ricgraph GitHub repository.
