Skip to content

Commit 8dbdca8

Browse files
committed
Removed remodeler CLI for hedpy, updated docs
1 parent 13d77fd commit 8dbdca8

28 files changed

Lines changed: 435 additions & 368 deletions

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,21 @@ Release 0.8.0 November 18, 2025
6464
- Fixed `remodel` commands: Corrected argument names, added missing parameters, fixed option conflicts.
6565
- Fixed `schema` commands: Corrected positional vs option argument structures for add-ids and create-ontology.
6666
- Added comprehensive test suite (`tests/test_cli_parameter_parity.py`) to verify CLI parameters match original parsers.
67-
- **JSON Schema Format Support**: Added comprehensive JSON format support for HED schemas alongside existing XML, MediaWiki, and TSV formats.
67+
- **JSON Schema Format Support**: Added comprehensive JSON format support for HED schemas alongside existing XML, MEDIAWIKI, and TSV formats.
6868
- Implemented `SchemaLoaderJSON` class for loading JSON schemas (`hed/schema/schema_io/json2schema.py`).
6969
- Implemented `Schema2JSON` class for exporting schemas to JSON (`hed/schema/schema_io/schema2json.py`).
7070
- Added JSON constants and key mappings (`hed/schema/schema_io/json_constants.py`).
7171
- Added `save_as_json()` and `get_as_json_string()` methods to HedSchema class.
7272
- JSON format uses flat tag structure with hierarchy metadata for easier programmatic access.
7373
- Separate units section in JSON format for improved AI/tool accessibility.
7474
- Placeholder structure for takes-value tags with proper attribute inheritance.
75-
- Full roundtrip validation ensures JSON format produces identical validation results to XML/MediaWiki.
75+
- Full roundtrip validation ensures JSON format produces identical validation results to XML/MEDIAWIKI.
7676
- **New BIDS Sidecar Extraction Tool**: Added `hed_extract_bids_sidecar` command-line script for extracting sidecar templates from BIDS datasets.
7777
- Configurable value columns and skip columns for flexible template generation.
7878
- Comprehensive logging support with file output and verbosity control.
7979
- Integrated with BidsDataset and TabularSummary classes for robust extraction.
8080
- **Schema Validation Enhancements**: Extended schema validation to include JSON format in roundtrip testing.
81-
- Updated `hed_script_util.py` to validate all 4 schema formats (XML, MediaWiki, TSV, JSON).
81+
- Updated `hed_script_util.py` to validate all 4 schema formats (XML, MEDIAWIKI, TSV, JSON).
8282
- Updated schema conversion script to automatically generate JSON format alongside other formats.
8383
- **Python Version Requirements**: Minimum Python version raised to 3.10 (dropped 3.9 support).
8484
- **Documentation Improvements**: Added comprehensive Google-style docstrings to all functions in `hed_script_util.py`.

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,9 @@ hedpy extract-sidecar /path/to/dataset --suffix events
7979
# Validate HED schemas
8080
hedpy schema validate /path/to/schema.xml
8181

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

85-
# Run remodeling operations on event files
86-
hedpy remodel run /path/to/data /path/to/remodel_config.json
8785
```
8886

8987
**Legacy commands** (deprecated, use `hedpy` instead):

docs/_static/custom.css

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,18 @@
1-
/* Custom styles for HED Python Tools Documentation - Furo Theme */
1+
/* Custom styles for HED Python tools Documentation - Furo Theme */
2+
3+
/* Project name styling below logo */
4+
.sidebar-brand-text {
5+
font-size: 1.5rem !important;
6+
font-weight: 600 !important;
7+
color: #0969da !important;
8+
margin-top: 0.5rem !important;
9+
text-align: center !important;
10+
}
11+
12+
html[data-theme="dark"] .sidebar-brand-text,
13+
body[data-theme="dark"] .sidebar-brand-text {
14+
color: #58a6ff !important;
15+
}
216

317
/* Quick Links sidebar styling - darker gray box with proper padding */
418
.sidebar-quicklinks {

docs/_templates/sidebar/brand.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{% extends "furo/sidebar/brand.html" %}
2+
3+
{% block brand_content %}
4+
{{ super() }}
5+
<div class="sidebar-brand-text">HED Python tools</div>
6+
{% endblock brand_content %}

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# -- Project information -----------------------------------------------------
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
88

9-
project = "HED Python Tools"
9+
project = "HED Python tools"
1010
copyright = "2024, HED Standard"
1111
author = "HED Standard"
1212

@@ -56,7 +56,7 @@
5656
"source_directory": "docs/",
5757
}
5858

59-
html_title = "HED Python Tools"
59+
html_title = "HED Python tools"
6060

6161
# Configure sidebar to show logo, search, navigation, and quick links
6262
html_sidebars = {

docs/introduction.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ The **hedtools** Python package (`hed-python` repository) provides:
2424
### Related tools and resources
2525

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

3434
## Installation
3535

0 commit comments

Comments
 (0)