Skip to content

Commit 4969a87

Browse files
committed
Removed the visualization code
1 parent 8005d83 commit 4969a87

9 files changed

Lines changed: 9 additions & 545 deletions

File tree

README.md

Lines changed: 6 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,10 @@
22

33
# HEDTools - Python
44

5-
```{index} HEDTools, Python tools, validation, analysis
6-
```
7-
85
> Python tools for validation, analysis, and transformation of HED (Hierarchical Event Descriptors) tagged datasets.
96
107
## Overview
118

12-
```{index} HED, Hierarchical Event Descriptors, BIDS, NWB
13-
```
14-
159
HED (Hierarchical Event Descriptors) is a framework for systematically describing both laboratory and real-world events as well as other experimental metadata. HED tags are comma-separated path strings that provide a standardized vocabulary for annotating events and experimental conditions.
1610

1711
**Key Features:**
@@ -27,14 +21,8 @@ HED (Hierarchical Event Descriptors) is a framework for systematically describin
2721

2822
## Quick start
2923

30-
```{index} quick start, getting started, installation
31-
```
32-
3324
### Online tools (no installation required)
3425

35-
```{index} online tools, web tools, hedtools.org
36-
```
37-
3826
For simple validation or transformation tasks, use the online tools at [https://hedtools.org/hed](https://hedtools.org/hed) - no installation needed!
3927

4028
Browser-based validation (no data upload) is available at [https://www.hedtags.org/hed-javascript](https://www.hedtags.org/hed-javascript)
@@ -43,9 +31,6 @@ A development version of the online tools is available at: [https://hedtools.org
4331

4432
### Python installation
4533

46-
```{index} installation; Python, pip install, PyPI
47-
```
48-
4934
**Requirements:** Python 3.10 or higher
5035

5136
Install from PyPI:
@@ -94,9 +79,6 @@ pip install -e ".[dev,docs,test,examples]"
9479

9580
### Basic usage
9681

97-
```{index} usage examples, HedString, load_schema_version, validation example
98-
```
99-
10082
```python
10183
from hed import HedString, load_schema_version
10284

@@ -116,9 +98,6 @@ else:
11698

11799
### Command-line tools
118100

119-
```{index} command-line tools, CLI, hedpy, validate-bids, extract-sidecar
120-
```
121-
122101
HEDTools provides a unified command-line interface with git-like subcommands:
123102

124103
```bash
@@ -148,13 +127,12 @@ hed_validate_schemas /path/to/schema.xml
148127

149128
**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.
150129

130+
**Note:** The visualization tools such as the word cloud visualization have been moved to a separate [hed-vis](https://pypi.org/project/hedvis/) project.
131+
151132
For more examples, see the [user guide](https://www.hedtags.org/hed-python/user_guide.html).
152133

153134
### Jupyter notebook examples
154135

155-
```{index} Jupyter notebooks, examples, interactive workflows
156-
```
157-
158136
**Note:** Example notebooks are available in the [GitHub repository](https://github.com/hed-standard/hed-python/tree/main/examples) only, not in the PyPI package.
159137

160138
The [`examples/`](examples/) directory contains Jupyter notebooks demonstrating common HED workflows with BIDS datasets:
@@ -185,9 +163,6 @@ See [`examples/README.md`](examples/README.md) for more details.
185163

186164
## Documentation
187165

188-
```{index} documentation, user guide, API reference, Sphinx
189-
```
190-
191166
📖 **Full Documentation:** [https://www.hedtags.org/hed-python](https://www.hedtags.org/hed-python)
192167

193168
- [User guide](https://www.hedtags.org/hed-python/user_guide.html) - Usage instructions
@@ -196,9 +171,6 @@ See [`examples/README.md`](examples/README.md) for more details.
196171

197172
### Building docs locally
198173

199-
```{index} building documentation, sphinx-build
200-
```
201-
202174
```bash
203175
# Install documentation dependencies
204176
pip install -e .[docs]
@@ -212,9 +184,6 @@ To iew the built documentation open `docs/_build/html/index.html` in your browse
212184

213185
### Formatting with Black
214186

215-
```{index} Black, code formatting, style guide
216-
```
217-
218187
This project uses [Black](https://black.readthedocs.io/) for consistent code formatting.
219188

220189
```bash
@@ -247,9 +216,6 @@ black --workers 1 .
247216

248217
## Related repositories
249218

250-
```{index} HED ecosystem, repositories, hed-schemas, hed-specification
251-
```
252-
253219
The HED ecosystem consists of several interconnected repositories:
254220

255221
| Repository | Description |
@@ -265,9 +231,6 @@ The HED ecosystem consists of several interconnected repositories:
265231

266232
## Contributing
267233

268-
```{index} contributing, development setup, pull requests
269-
```
270-
271234
We welcome contributions! Here's how you can help:
272235

273236
1. **Report issues:** Use [GitHub Issues](https://github.com/hed-standard/hed-python/issues) for bug reports and feature requests
@@ -304,14 +267,8 @@ For detailed contribution guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.
304267

305268
## Configuration
306269

307-
```{index} configuration, schema caching, cache directory
308-
```
309-
310270
### Schema caching
311271

312-
~~~{index} schema; caching, ~/.hedtools
313-
~~~
314-
315272
By default, HED schemas are cached in `~/.hedtools/` (location varies by OS).
316273

317274
```python
@@ -343,7 +300,8 @@ HEDTools is licensed under the MIT License. See [LICENSE](LICENSE) for details.
343300

344301
## Support
345302

346-
- [Documentation](https://www.hedtags.org/hed-python)
347-
- [GitHub issues](https://github.com/hed-standard/hed-python/issues)
348-
- [HED Homepage](https://www.hedtags.org)
303+
- HED documentation: [www.hedtags.org/hed-resources](https:/www.hedtags.org/hed-resources)
304+
- HED homepage: [www.hedtags.org](https://www.hedtags.org)
305+
- GitHub issues: [https://github.com/hed-standard/hed-python/issues](https://github.com/hed-standard/hed-python/issues)
306+
- Questions or ideas: [HED discussions](https://github.com/orgs/hed-standard/discussions)
349307
- Contact: [hed-maintainers@gmail.com](mailto:hed-maintainers@gmail.com)

hed/tools/visualization/__init__.py

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

hed/tools/visualization/tag_word_cloud.py

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

0 commit comments

Comments
 (0)