Skip to content

nih-cfde/icc-eval-core

Repository files navigation

Common Fund Data Ecosystem (CFDE) Integration and Coordination Center (ICC) Evaluation Core

Background

The Common Fund Data Ecosystem (CFDE) is an effort to bring together knowledge across NIH Common Fund programs into a cohesive resource.

We are the Integration and Coordination Center (ICC), a center within the CFDE. We are responsible for (among other things) gathering info associated with Common Fund projects and sharing it with the NIH. We also aim to make already-public info more accessible by presenting it in a centralized way.

See https://nih-cfde.github.io/icc-eval-coordination/ for more context.

Contents

  • /frontend: A dashboard written in Vue that shows basic metrics about CFDE ecosystem. Uses backend API to display its data.
  • /data: A pipeline written in TypeScript that gathers information from various sources and exports them as JSON files which then get imported into backend database.
  • /backend: A REST API written in Python using Django that provides programmatic access to all of information gathered by pipeline. Private info only viewable by authorized users via ORCID authentication.
  • /services: Configuration files for other services needed to run stack.

Run application

Install Docker and Docker Compose: https://docs.docker.com/get-docker/

Launch backend, frontend, and other required services in a Docker environment:

./run_stack.sh

Once everything has launched, access services at:

Run pipeline

Run main info gathering pipeline, outside of container:

./run_pipeline.sh --gather

Run main info gathering pipeline, inside container:

./run_stack.sh --profile pipeline run --rm -it pipeline

Pipeline should output JSON files under /data/output and /data/raw.

Import info into backend

Import results of pipeline into backend database (runs import_dataset inside backend container):

./run_stack.sh run --rm -it backend uv run /app/icc_eval_core_api/manage.py import_dataset /data/output/

About

Tools for collecting and reporting CFDE metrics

Topics

Resources

Stars

1 star

Watchers

3 watching

Forks

Contributors