seedcase-project / seedcase-sprout

Upload your research data to formally structure it for better, more reliable, and easier research.
https://sprout.seedcase-project.org/
MIT License
0 stars 0 forks source link

Seedcase Sprout: Grow your data in a structured and healthy way

Sprout is a component of the Seedcase framework that aims to take data created or collected for research studies and "grow" it in a structured way using modern data engineering best practices.

Sprout is the backbone of the Seedcase family; this is where data is uploaded, described, and stored based on a relational database design. Sprout is also the application which contains the user administration part of Seedcase (although this may change at a later date).

Seedcase Sprout is designed to receive data files and guide the user through adding metadata to the research data that the user of Seedcase would like to store in a responsible way.

Check out a demo of Sprout, where you can upload a csv file with data and experience how to add metadata.

Installation

This project uses Poetry to manage dependencies. To install Poetry, run:

pipx install poetry

To run any Python commands within this project, always append the command with poetry run, for instance:

poetry run python manage.py runserver

Or with the justfile:

just start-app

... which will run the Django project locally.

Running the application with docker

You can run the Django application with docker:

# Run application
docker compose up -d

Check "http://localhost:8000"

# Terminate application
docker compose down

Or with the justfile:

just start-docker
just stop-docker