Skip to content

Commit 1654c5b

Browse files
committed
added key features section to readme
1 parent 943c6f6 commit 1654c5b

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,38 @@
77

88
# ancpBIDS Technical Overview
99

10+
## Key Features
11+
12+
- **BIDS Dataset Loading**
13+
Load BIDS datasets of any size or complexity, with support for multiple BIDS schema versions.
14+
15+
- **Flexible Query Engine**
16+
Query files, folders, and metadata using a powerful, Pythonic API. Supports entity-based, scope-based, and custom queries.
17+
18+
- **Validation**
19+
Validate datasets against the BIDS specification and custom rules using a plugin-based validation system.
20+
21+
- **Writing and Derivatives**
22+
Write and update BIDS datasets, including support for creating and saving BIDS derivatives.
23+
24+
- **Lazy Loading**
25+
Efficiently handle large datasets with optional lazy loading, reducing memory usage and speeding up initial access.
26+
27+
- **Plugin Architecture**
28+
Extend or customize core functionality (validation, file handling, schema, etc.) via a robust plugin system.
29+
30+
- **PyBIDS Compatibility Layer**
31+
Drop-in compatibility for many `pybids` API calls, easing migration from or integration with existing codebases.
32+
33+
- **Synthetic and Real Data Support**
34+
Works with both synthetic test datasets and real-world BIDS datasets.
35+
36+
- **CI/CD Ready**
37+
Includes a comprehensive suite of automated and manual tests, with synthetic datasets for reproducibility.
38+
39+
- **Extensible and Versioned Schema**
40+
Supports multiple BIDS schema versions and allows for easy extension as the BIDS standard evolves.
41+
1042
## Architecture
1143

1244
**ancpBIDS** is a modular Python library for reading, querying, validating, and writing BIDS datasets. Its architecture is designed for extensibility and maintainability, with the following key components:

0 commit comments

Comments
 (0)