Skip to content

Commit 3df8d82

Browse files
docs: 🔥 remove more general requirements (#1532)
# Description They will be moved to the design docs in seedcase-project/design#220. This PR needs an in-depth review. ## Checklist - [X] Ran `just run-all` --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent c6bfaa9 commit 3df8d82

File tree

2 files changed

+9
-22
lines changed

2 files changed

+9
-22
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,15 +85,17 @@ effort to create a framework for data management and analysis in
8585
research. If you use this project in your work, please cite it as
8686
follows:
8787

88-
Johnston L.W., Brødbæk S.K., Beicher K., Vago M. Seedcase Sprout: Grow
89-
structured, organised, and FAIR data. DOI: 10.5281/zenodo.15800477 URL:
90-
https://sprout.seedcase-project.org
88+
Johnston L.W., Brødbæk S.K., Beicher K., Vago M. (2025). Seedcase
89+
Sprout: Grow structured, organised, and FAIR data. DOI:
90+
10.5281/zenodo.15800477 URL: https://sprout.seedcase-project.org
9191

9292
Or as a BibTeX entry:
9393

9494
@misc{YourReferenceHere,
9595
author = {Johnston, Luke William and Brødbæk, Signe Kirk and Beicher, Kristiane and Vago, Marton},
9696
doi = {10.5281/zenodo.15800477},
97+
month = {7},
9798
title = {Seedcase Sprout: Grow structured, organised, and FAIR data.},
98-
url = {https://sprout.seedcase-project.org}
99+
url = {https://sprout.seedcase-project.org},
100+
year = {2025}
99101
}

docs/design/index.qmd

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -52,18 +52,10 @@ focused and narrow scope as well as being extensible or customizable,
5252

5353
Overall, Sprout must:
5454

55-
- Run on Windows, MacOS, and Linux: Our potential users work on any of
56-
these systems (including servers), so we need to ensure
57-
compatibility across the most commonly used operating systems.
58-
- Integrate GDPR, privacy, and security compliance: Many of our users
59-
work with health or personally sensitive data.
60-
- Run remotely on servers and locally on computers: The location where
61-
data are stored should be flexible based on the needs and
62-
restrictions of the user.
6355
- Be able to handle a variety of data file sizes: While the size of
64-
research data usually does not compare to that found in industry, it
65-
can still become large enough that it requires special care and
66-
handling.
56+
research data usually does not compare to that found in industry,
57+
Sprout must be able to handle data that is large enough to requires
58+
special care and handling.
6759
- Store data in a format that is open source, integrates with many
6860
tools, and is storage efficient: Sprout is first and foremost a data
6961
engineering tool for research data storage and distribution (or at
@@ -84,13 +76,6 @@ Overall, Sprout must:
8476
changes and provide a way to show, track, and manage versions of the
8577
data. This is also necessary for legal compliance, auditing and
8678
record-keeping.
87-
- Individual pieces of functionality should be independent: To keep it
88-
flexible and extensible, each functionality should (ideally) be able
89-
to run on its own without depending on other functionality.
90-
- Assume as little as possible about the environment: For each
91-
functionality, ideally assume as little about the current state of
92-
the environment as possible. For instance, what the exact path is on
93-
the filesystem or where in the filesystem the software is running.
9479
- Rely on as few assumptions and expectations as possible: This
9580
package should not be (too) opinionated about the order steps are
9681
taken, what steps are taken, where they are taken, and other

0 commit comments

Comments
 (0)