From aad453f1dd00963c367f6f6ee3b651f93cdb3baa Mon Sep 17 00:00:00 2001 From: Kay Robbins <1189050+VisLab@users.noreply.github.com> Date: Sat, 3 Aug 2024 08:58:35 -0500 Subject: [PATCH 1/3] Added a CHANGELOG --- CHANGELOG.md | 13 +++++++++++++ README.md | 3 ++- 2 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..b67295b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,13 @@ +## Release 1.0.0 August 3, 2024 - Initial release + +- Implements a base class `HedTools` with following interface: + - `generateSidecar` + - `getHedAnnotations` + - `searchHed + - `validateEvents` + - `validateSidecar` + - `validateTags` + - `resetHedVersion` +- Provides two implementations of the interface: + - `HedToolsService` - calls web services to perform the operations + - `HedToolsPython` - calls local installed Python libraries to perform the operations \ No newline at end of file diff --git a/README.md b/README.md index 2d9f321..1f28e7f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -[![Documentation Status](https://readthedocs.org/projects/hed-matlab/badge/?version=latest)](https://www.hed-matlab.org/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/hed-matlab/badge/?version=latest)](https://www.hed-matlab.org/en/latest/?badge=latest) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13201057.svg)](https://doi.org/10.5281/zenodo.13201057) # HED-MATLAB This repository contains the MATLAB supporting code infrastructure From 67406689d28ce3a75b12dbcf1952dafa4829a196 Mon Sep 17 00:00:00 2001 From: Kay Robbins <1189050+VisLab@users.noreply.github.com> Date: Sat, 3 Aug 2024 09:07:26 -0500 Subject: [PATCH 2/3] Updated the readthedocs page --- docs/source/index.rst | 6 ++---- docs/source/introduction.rst | 20 +++++--------------- docs/source/user_guide.rst | 9 --------- 3 files changed, 7 insertions(+), 28 deletions(-) delete mode 100644 docs/source/user_guide.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 42eea71..2cb014e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,19 +7,17 @@ Hierarchical Event Descriptor (HED) MATLAB Tools .. sidebar:: **Links** - * `PDF docs `_ + * `API docs `_ * `Source code `_ -Note: this is a work in progress. More information is coming. .. toctree:: :maxdepth: 6 :caption: Contents: introduction.md - user_guide.rst - + .. toctree:: :maxdepth: 6 :caption: HED MATLAB API: diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 3ff7f3c..3ce670e 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -19,20 +19,10 @@ Why HED? so that tools can automatically use this information in analysis. For more information on using Hierarchical Event Descriptors (HED) -visit `HED examples `_: +visit the `HED homepage` `_: +and the `HED resources page `_: -Installing hedtools -=================== -Hedtools will be available soon on pypi, but in the meantime, -you can install directly from the -`GitHub repository `_ -using the following command: - -```code ->>> pip install git+https://github.com/hed-standard/hed-python.git -``` - Finding help ============ @@ -44,7 +34,7 @@ Finding help :Issues and problems: - * If you notice a bug in the python hedtools code or encounter other problems using the tools, please `open an issue`_ in the - hed-python repository on github. + * If you notice a bug in the HED tools for matlab code or encounter other problems using the tools, please `open an issue`_ in the + hed-matlab repository on github. -.. _open an issue: https://github.com/hed-standard/hed-python/issues +.. _open an issue: https://github.com/hed-standard/hed-matlab/issues diff --git a/docs/source/user_guide.rst b/docs/source/user_guide.rst deleted file mode 100644 index 2178062..0000000 --- a/docs/source/user_guide.rst +++ /dev/null @@ -1,9 +0,0 @@ - -.. _user_guide: - -HED tools user guide -==================== - -.. toctree:: - :numbered: - From c1852a0c92ce300663b800bd7059e280361e6b54 Mon Sep 17 00:00:00 2001 From: Kay Robbins <1189050+VisLab@users.noreply.github.com> Date: Sat, 3 Aug 2024 09:09:12 -0500 Subject: [PATCH 3/3] Spacing in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f28e7f..f0cdae2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Documentation Status](https://readthedocs.org/projects/hed-matlab/badge/?version=latest)](https://www.hed-matlab.org/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/hed-matlab/badge/?version=latest)](https://www.hed-matlab.org/en/latest/?badge=latest) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13201057.svg)](https://doi.org/10.5281/zenodo.13201057) # HED-MATLAB