Skip to content

Commit 04bfdad

Browse files
committed
Corrected formatting
1 parent 3ae3878 commit 04bfdad

4 files changed

Lines changed: 67 additions & 21 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
```markdown
1+
````markdown
22
Release 0.8.1 December 9, 2025
33

44
The primary purpose of this release was to correct the JSON format for HED schemas so that it would accurately distinguish between inherited and non-inherited attributes. The documentation layout was also improved with quick links.
@@ -175,4 +175,5 @@ Release 0.2.0 February 14, 2023
175175
- First pass at search and summarization.
176176

177177
Release 0.1.0 June 20, 2022
178-
- First release on PyPI
178+
- First release on PyPI```
179+
````

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
1-
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8056010.svg)](https://doi.org/10.5281/zenodo.8056010)
2-
[![Maintainability](https://qlty.sh/gh/hed-standard/projects/hed-python/maintainability.svg)](https://qlty.sh/gh/hed-standard/projects/hed-python)
3-
[![Code Coverage](https://qlty.sh/gh/hed-standard/projects/hed-python/coverage.svg)](https://qlty.sh/gh/hed-standard/projects/hed-python)
4-
![Python3](https://img.shields.io/badge/python->=3.10-yellow.svg)
5-
![PyPI - Status](https://img.shields.io/pypi/v/hedtools)
6-
[![Documentation](https://img.shields.io/badge/docs-hed--python-blue.svg)](https://www.hedtags.org/hed-python)
1+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8056010.svg)](https://doi.org/10.5281/zenodo.8056010) [![Maintainability](https://qlty.sh/gh/hed-standard/projects/hed-python/maintainability.svg)](https://qlty.sh/gh/hed-standard/projects/hed-python) [![Code Coverage](https://qlty.sh/gh/hed-standard/projects/hed-python/coverage.svg)](https://qlty.sh/gh/hed-standard/projects/hed-python) ![Python3](https://img.shields.io/badge/python-%3E=3.10-yellow.svg) ![PyPI - Status](https://img.shields.io/pypi/v/hedtools) [![Documentation](https://img.shields.io/badge/docs-hed--python-blue.svg)](https://www.hedtags.org/hed-python)
72

83
# HEDTools - Python
94

@@ -14,6 +9,7 @@
149
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.
1510

1611
**Key Features:**
12+
1713
- Validate HED annotations against schema specifications
1814
- Analyze and summarize HED-tagged datasets
1915
- Transform and remodel event data
@@ -37,11 +33,13 @@ A development version is available at: [https://hedtools.org/hed_dev](https://he
3733
**Requirements:** Python 3.10 or higher
3834

3935
Install from PyPI:
36+
4037
```bash
4138
pip install hedtools
4239
```
4340

4441
Or install from GitHub (latest):
42+
4543
```bash
4644
pip install git+https://github.com/hed-standard/hed-python/@main
4745
```
@@ -89,6 +87,7 @@ hedpy remodel run /path/to/data /path/to/remodel_config.json
8987
```
9088

9189
**Legacy commands** (deprecated, use `hedpy` instead):
90+
9291
```bash
9392
validate_bids /path/to/dataset
9493
hed_validate_schemas /path/to/schema.xml
@@ -132,7 +131,7 @@ See [`examples/README.md`](examples/README.md) for more details.
132131
📖 **Full Documentation:** [https://www.hedtags.org/hed-python](https://www.hedtags.org/hed-python)
133132

134133
- [User Guide](https://www.hedtags.org/hed-python/user_guide.html) - Usage instructions
135-
- [API Reference](https://www.hedtags.org/hed-python/api/index.html) - Detailed API documentation
134+
- [API Reference](https://www.hedtags.org/hed-python/api/index.html) - Detailed API documentation
136135
- [HED Specification](https://www.hedtags.org/hed-specification) - Full HED standard specification
137136

138137
### Building docs locally
@@ -172,6 +171,7 @@ black tests/
172171
```
173172

174173
**Windows Users:** If you encounter "I/O operation on closed file" errors, use the `--workers 1` flag:
174+
175175
```bash
176176
black --workers 1 --check .
177177
black --workers 1 .
@@ -187,16 +187,15 @@ black --workers 1 .
187187

188188
The HED ecosystem consists of several interconnected repositories:
189189

190-
| Repository | Description |
191-
|------------|-------------|
192-
| [hed-python](https://github.com/hed-standard/hed-python) | Python validation and analysis tools (this repo) |
193-
| [hed-web](https://github.com/hed-standard/hed-web) | Web interface and deployable Docker services |
194-
| [hed-resources](https://github.com/hed-standard/hed-resources) | Example code in Python and MATLAB + HED resources |
195-
| [hed-specification](https://github.com/hed-standard/hed-specification) | Official HED specification documents |
196-
| [hed-schemas](https://github.com/hed-standard/hed-schemas) | Official HED schema repository |
197-
| [ndx-hed](https://github.com/hed-standard/ndx-hed) | HED support for NWB |
198-
| [hed-javascript](https://github.com/hed-standard/hed-javascript) | JavaScript HED validation tools |
199-
190+
| Repository | Description |
191+
| ---------------------------------------------------------------------- | ------------------------------------------------- |
192+
| [hed-python](https://github.com/hed-standard/hed-python) | Python validation and analysis tools (this repo) |
193+
| [hed-web](https://github.com/hed-standard/hed-web) | Web interface and deployable Docker services |
194+
| [hed-resources](https://github.com/hed-standard/hed-resources) | Example code in Python and MATLAB + HED resources |
195+
| [hed-specification](https://github.com/hed-standard/hed-specification) | Official HED specification documents |
196+
| [hed-schemas](https://github.com/hed-standard/hed-schemas) | Official HED schema repository |
197+
| [ndx-hed](https://github.com/hed-standard/ndx-hed) | HED support for NWB |
198+
| [hed-javascript](https://github.com/hed-standard/hed-javascript) | JavaScript HED validation tools |
200199

201200
## Contributing
202201

@@ -208,6 +207,7 @@ We welcome contributions! Here's how you can help:
208207
4. **Share examples:** Contribute example code and use cases
209208

210209
**Development setup:**
210+
211211
```bash
212212
# Clone the repository
213213
git clone https://github.com/hed-standard/hed-python.git

0 commit comments

Comments
 (0)