Skip to content

Commit 8ac2cbe

Browse files
committed
Removed the remodeling tools (issue hed-standard#1180)
1 parent ca85632 commit 8ac2cbe

113 files changed

Lines changed: 72 additions & 10843 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,13 @@ HED (Hierarchical Event Descriptors) is a framework for systematically describin
1818

1919
- Validate HED annotations against schema specifications
2020
- Analyze and summarize HED-tagged datasets
21-
- Transform and remodel event data
2221
- Full HED support in BIDS (Brain Imaging Data Structure)
2322
- HED support in NWB (Neurodata Without Borders) when used the [ndx-hed](https://github.com/hed-standard/ndx-hed) extension.
2423
- Platform-independent and data-neutral
2524
- Command-line tools and Python API
2625

26+
**Note:** Table remodeling tools have been moved to a separate package. See [table-remodeler](https://pypi.org/project/table-remodeler/) on PyPI or visit [https://www.hedtags.org/table-remodeler](https://www.hedtags.org/table-remodeler) for more information.
27+
2728
## Quick start
2829

2930
```{index} quick start, getting started, installation
@@ -59,6 +60,38 @@ Or install from GitHub (latest):
5960
pip install git+https://github.com/hed-standard/hed-python/@main
6061
```
6162

63+
### Development installation
64+
65+
```{index} development installation, editable install, optional dependencies
66+
```
67+
68+
For development work or to access optional features, install from the cloned repository:
69+
70+
```bash
71+
# Clone the repository
72+
git clone https://github.com/hed-standard/hed-python.git
73+
cd hed-python
74+
75+
# Install in editable mode with base dependencies
76+
pip install -e .
77+
78+
# Install with optional dependency groups
79+
pip install -e ".[dev]" # Development tools (ruff, black, codespell)
80+
pip install -e ".[docs]" # Documentation tools (sphinx, furo)
81+
pip install -e ".[test]" # Testing tools (coverage)
82+
pip install -e ".[examples]" # Jupyter notebook support
83+
84+
# Install all optional dependencies
85+
pip install -e ".[dev,docs,test,examples]"
86+
```
87+
88+
**Optional dependency groups:**
89+
90+
- `dev` - Code quality tools: ruff (linter), black (formatter), codespell, mdformat
91+
- `docs` - Documentation generation: sphinx, furo theme, myst-parser
92+
- `test` - Code coverage reporting: coverage
93+
- `examples` - Jupyter notebook support: jupyter, notebook, ipykernel
94+
6295
### Basic usage
6396

6497
```{index} usage examples, HedString, load_schema_version, validation example
@@ -111,9 +144,10 @@ hedpy schema convert /path/to/schema.xml
111144
```bash
112145
validate_bids /path/to/dataset
113146
hed_validate_schemas /path/to/schema.xml
114-
run_remodel /path/to/data /path/to/config.json
115147
```
116148

149+
**Note:** The `run_remodel` command has been removed. Table remodeling functionality is now available in the separate [table-remodeler](https://pypi.org/project/table-remodeler/) package.
150+
117151
For more examples, see the [user guide](https://www.hedtags.org/hed-python/user_guide.html).
118152

119153
### Jupyter notebook examples
@@ -172,14 +206,10 @@ pip install -e .[docs]
172206
# Build the documentation
173207
cd docs
174208
sphinx-build -b html . _build/html
175-
176-
# Or use the make command (if available)
177-
make html
178-
179-
# View the built documentation
180-
# Open docs/_build/html/index.html in your browser
181209
```
182210

211+
To iew the built documentation open `docs/_build/html/index.html` in your browser
212+
183213
### Formatting with Black
184214

185215
```{index} Black, code formatting, style guide
@@ -229,6 +259,7 @@ The HED ecosystem consists of several interconnected repositories:
229259
| [hed-resources](https://github.com/hed-standard/hed-resources) | Tutorials and other HED resources |
230260
| [hed-specification](https://github.com/hed-standard/hed-specification) | Official HED specification documents |
231261
| [hed-schemas](https://github.com/hed-standard/hed-schemas) | Official HED schema repository |
262+
| [table-remodeler](https://github.com/hed-standard/table-remodeler) | Table transformation and remodeling tools |
232263
| [ndx-hed](https://github.com/hed-standard/ndx-hed) | HED support for NWB |
233264
| [hed-javascript](https://github.com/hed-standard/hed-javascript) | JavaScript HED validation tools |
234265

docs/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
.. meta::
2+
:description: Python tools for HED (Hierarchical Event Descriptors) validation, analysis, and BIDS integration in neuroscience
3+
:keywords: HED, hierarchical event descriptors, Python, validation, BIDS, neuroscience, event annotation, metadata, analysis tools
4+
15
Python HEDTools
26
===============
37

docs/overview.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
```{meta}
2+
---
3+
description: Overview of Python HEDTools - validation, analysis, and processing
4+
tools for Hierarchical Event Descriptors (HED) in neuroscience
5+
keywords: HED overview, Python tools, event descriptors, BIDS, NWB,
6+
neuroscience, validation, schema
7+
---
8+
```
9+
110
# Python HEDTools overview
211

312
```{index} single: HED; overview

docs/user_guide.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
```{meta}
2+
---
3+
description: Complete user guide for Python HEDTools - validation, BIDS
4+
integration, analysis, and command-line tools for HED annotations
5+
keywords: HED tutorial, Python guide, validation examples, BIDS datasets,
6+
sidecar files, command-line interface, Jupyter notebooks
7+
---
8+
```
9+
110
# Python HEDTools guide
211

312
```{index} user guide, tutorial, getting started

hed/tools/__init__.py

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""HED remodeling, analysis and summarization tools."""
1+
"""HED analysis and summarization tools."""
22

33
from .analysis.event_manager import EventManager
44
from .analysis.file_dictionary import FileDictionary
@@ -19,27 +19,6 @@
1919
from .bids.bids_tabular_file import BidsTabularFile
2020
from .bids.bids_util import parse_bids_filename
2121

22-
from .remodeling.dispatcher import Dispatcher
23-
from .remodeling.backup_manager import BackupManager
24-
from .remodeling.operations.base_summary import BaseSummary
25-
from .remodeling.operations.base_op import BaseOp
26-
from .remodeling.operations.factor_column_op import FactorColumnOp
27-
from .remodeling.operations.factor_hed_tags_op import FactorHedTagsOp
28-
from .remodeling.operations.factor_hed_type_op import FactorHedTypeOp
29-
from .remodeling.operations.merge_consecutive_op import MergeConsecutiveOp
30-
from .remodeling.operations.number_groups_op import NumberGroupsOp
31-
from .remodeling.operations.number_rows_op import NumberRowsOp
32-
from .remodeling.operations import valid_operations
33-
from .remodeling.operations.remap_columns_op import RemapColumnsOp
34-
from .remodeling.operations.remove_columns_op import RemoveColumnsOp
35-
from .remodeling.operations.remove_rows_op import RemoveRowsOp
36-
from .remodeling.operations.rename_columns_op import RenameColumnsOp
37-
from .remodeling.operations.reorder_columns_op import ReorderColumnsOp
38-
from .remodeling.operations.split_rows_op import SplitRowsOp
39-
from .remodeling.operations.summarize_column_names_op import SummarizeColumnNamesOp
40-
from .remodeling.operations.summarize_column_values_op import SummarizeColumnValuesOp
41-
from .remodeling.operations.summarize_hed_type_op import SummarizeHedTypeOp
42-
4322
from .util.data_util import get_new_dataframe, get_value_dict, replace_values, reorder_columns
4423
from .util.io_util import check_filename, clean_filename, extract_suffix_path, get_file_list, make_path
4524
from .util.io_util import get_path_components
@@ -55,7 +34,3 @@
5534
strs_to_sidecar,
5635
to_strlist,
5736
)
58-
59-
from .remodeling.cli import run_remodel
60-
from .remodeling.cli import run_remodel_backup
61-
from .remodeling.cli import run_remodel_restore

hed/tools/remodeling/__init__.py

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)