Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,21 +64,21 @@ Release 0.8.0 November 18, 2025
- Fixed `remodel` commands: Corrected argument names, added missing parameters, fixed option conflicts.
- Fixed `schema` commands: Corrected positional vs option argument structures for add-ids and create-ontology.
- Added comprehensive test suite (`tests/test_cli_parameter_parity.py`) to verify CLI parameters match original parsers.
- **JSON Schema Format Support**: Added comprehensive JSON format support for HED schemas alongside existing XML, MediaWiki, and TSV formats.
- **JSON Schema Format Support**: Added comprehensive JSON format support for HED schemas alongside existing XML, MEDIAWIKI, and TSV formats.
- Implemented `SchemaLoaderJSON` class for loading JSON schemas (`hed/schema/schema_io/json2schema.py`).
- Implemented `Schema2JSON` class for exporting schemas to JSON (`hed/schema/schema_io/schema2json.py`).
- Added JSON constants and key mappings (`hed/schema/schema_io/json_constants.py`).
- Added `save_as_json()` and `get_as_json_string()` methods to HedSchema class.
- JSON format uses flat tag structure with hierarchy metadata for easier programmatic access.
- Separate units section in JSON format for improved AI/tool accessibility.
- Placeholder structure for takes-value tags with proper attribute inheritance.
- Full roundtrip validation ensures JSON format produces identical validation results to XML/MediaWiki.
- Full roundtrip validation ensures JSON format produces identical validation results to XML/MEDIAWIKI.
- **New BIDS Sidecar Extraction Tool**: Added `hed_extract_bids_sidecar` command-line script for extracting sidecar templates from BIDS datasets.
- Configurable value columns and skip columns for flexible template generation.
- Comprehensive logging support with file output and verbosity control.
- Integrated with BidsDataset and TabularSummary classes for robust extraction.
- **Schema Validation Enhancements**: Extended schema validation to include JSON format in roundtrip testing.
- Updated `hed_script_util.py` to validate all 4 schema formats (XML, MediaWiki, TSV, JSON).
- Updated `hed_script_util.py` to validate all 4 schema formats (XML, MEDIAWIKI, TSV, JSON).
- Updated schema conversion script to automatically generate JSON format alongside other formats.
- **Python Version Requirements**: Minimum Python version raised to 3.10 (dropped 3.9 support).
- **Documentation Improvements**: Added comprehensive Google-style docstrings to all functions in `hed_script_util.py`.
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,9 @@ hedpy extract-sidecar /path/to/dataset --suffix events
# Validate HED schemas
hedpy schema validate /path/to/schema.xml

# Convert schema between formats (XML, MediaWiki, TSV, JSON)
# Convert schema between formats (XML, MEDIAWIKI, TSV, JSON)
hedpy schema convert /path/to/schema.xml

# Run remodeling operations on event files
hedpy remodel run /path/to/data /path/to/remodel_config.json
```

**Legacy commands** (deprecated, use `hedpy` instead):
Expand Down
16 changes: 15 additions & 1 deletion docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
/* Custom styles for HED Python Tools Documentation - Furo Theme */
/* Custom styles for HED Python tools Documentation - Furo Theme */

/* Project name styling below logo */
.sidebar-brand-text {
font-size: 1.5rem !important;
font-weight: 600 !important;
color: #0969da !important;
margin-top: 0.5rem !important;
text-align: center !important;
}

html[data-theme="dark"] .sidebar-brand-text,
body[data-theme="dark"] .sidebar-brand-text {
color: #58a6ff !important;
}

/* Quick Links sidebar styling - darker gray box with proper padding */
.sidebar-quicklinks {
Expand Down
6 changes: 6 additions & 0 deletions docs/_templates/sidebar/brand.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{% extends "furo/sidebar/brand.html" %}

{% block brand_content %}
{{ super() }}
<div class="sidebar-brand-text">HED Python tools</div>
{% endblock brand_content %}
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "HED Python Tools"
project = "HED Python tools"
copyright = "2024, HED Standard"
author = "HED Standard"

Expand Down Expand Up @@ -56,7 +56,7 @@
"source_directory": "docs/",
}

html_title = "HED Python Tools"
html_title = "HED Python tools"

# Configure sidebar to show logo, search, navigation, and quick links
html_sidebars = {
Expand Down
12 changes: 6 additions & 6 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ The **hedtools** Python package (`hed-python` repository) provides:
### Related tools and resources

- **[HED homepage](https://www.hedtags.org)**: Overview and links for HED
- **[HED Schemas](https://github.com/hed-standard/hed-schemas)**: Standardized vocabularies in XML/MediaWiki/OWL formats
- **[HED Specification](https://www.hedtags.org/hed-specification/)**: Formal specification defining HED annotation rules
- **[HED Online Tools](https://hedtools.org/hed)**: Web-based interface requiring no programming
- **[HED Examples](https://github.com/hed-standard/hed-examples)**: Example datasets annotated with HED
- **[HED Resources](https://www.hedtags.org/hed-resources)**: Comprehensive tutorials and documentation
- **[HED MATLAB Tools](https://www.hedtags.org/hed-resources/HedMatlabTools.html)**: MATLAB wrapper for Python tools
- **[HED schemas](https://github.com/hed-standard/hed-schemas)**: Standardized vocabularies in XML/MEDIAWIKI/TSV/JSON formats
- **[HED specification](https://www.hedtags.org/hed-specification/)**: Formal specification defining HED annotation rules
- **[HED online tools](https://hedtools.org/hed)**: Web-based interface requiring no programming
- **[HED examples](https://github.com/hed-standard/hed-examples)**: Example datasets annotated with HED
- **[HED resources](https://www.hedtags.org/hed-resources)**: Comprehensive tutorials and documentation
- **[HED MATLAB tools](https://www.hedtags.org/hed-resources/HedMatlabTools.html)**: MATLAB wrapper for Python tools

## Installation

Expand Down
Loading