From 7960fed4dd2e851a4a9e17c20283e1ec5fb6fa7a Mon Sep 17 00:00:00 2001 From: Kay Robbins <1189050+VisLab@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:36:06 -0600 Subject: [PATCH] Update badges in readme --- README.md | 205 +++++++++++++++++++++++++++--------------------------- 1 file changed, 103 insertions(+), 102 deletions(-) diff --git a/README.md b/README.md index 252177ee..c886fe8f 100644 --- a/README.md +++ b/README.md @@ -1,102 +1,103 @@ -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8056010.svg)](https://doi.org/10.5281/zenodo.8056010) -[![Maintainability](https://api.codeclimate.com/v1/badges/11bf2329590e7b0164ba/maintainability)](https://codeclimate.com/github/hed-standard/hed-python/maintainability) -[![Test Coverage](https://api.codeclimate.com/v1/badges/11bf2329590e7b0164ba/test_coverage)](https://codeclimate.com/github/hed-standard/hed-python/test_coverage) -![PyPI - Status](https://img.shields.io/pypi/v/hedtools) -[![Documentation Status](https://readthedocs.org/projects/hed-python/badge/?version=latest)](https://hed-python.readthedocs.io/en/latest/?badge=latest) - -# HEDTools - Python -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. -HED, itself, is platform-independent, extendable, and data-neutral. - -This repository contains the underlying python tools that support validation, -summarization, and analysis of datasets using HED tags. - -Most people will simply annotate their events by creating a spreadsheet -or a BIDS JSON sidecar that associates HED tags with event codes or the events themselves. -If you have such a spreadsheet or a JSON, -you can use the HED Online Validator currently available at -[https://hedtools.org](https://hedtools.org) to validate or transform -your files without downloading any tools. - -A version of the online tools corresponding to the `develop` branch can be found at: -[https://hedtools.org/hed_dev](https://hedtools.org/hed_dev). - -### Installation -Use `pip` to install `hedtools` from PyPI: - - ``` - pip install hedtools - ``` - -To install directly from the -[GitHub](https://github.com/hed-standard/hed-python) repository `master` branch: - - ``` - pip install git+https://github.com/hed-standard/hed-python/@master - ``` - -The HEDTools in this repository require Python 3.8 or greater. - -### Relationship to other repositories - -The `hed-python` repository contains the Python infrastructure for validating -and analyzing HED. This repository has several companion repositories: -- [`hed-web`](https://github.com/hed-standard/hed-web) contains the web interface -for HED as well as a deployable docker module that supports web services for HED. -- [`hed-examples`](https://github.com/hed-standard/hed-examples) contains examples of -using HED in Python and MATLAB. This repository also houses the HED resources. -See [https://www.hed-resources.org](https://www.hed-resources.org) for access to these. -- [`hed-specification`](https://github.com/hed-standard/hed-specification) contains -the HED specification documents. The `hed-python` validator is keyed to error codes -in this document. -- [`hed-schemas`](https://github.com/hed-standard/hed-schemas) contains -the official HED schemas. The tools access this repository to retrieve and cache schema versions -during execution. Starting with `hedtools 0.2.0` local copies of the most recent schema versions -are stored within the code modules for easy access. - -#### Develop versus master versus stable branches - -The `hed-python` repository - -| Branch | Meaning | Synchronized with | -| ------ | -------- | ------------------ | -| stable | Officially released on PyPI as a tagged version. | `stable@hed-web`
`stable@hed-specification`
`stable@hed-examples` | -| latest | Most recent usable version. | `latest@hed-web`
`latest@hed-specification`
`latest@hed-examples` | -| develop | Experimental and evolving. | `develop@hed-web`
`develop@hed-specification`
`develop@hed-examples` | - -As features are integrated, they first appear in the `develop` branches of the -repositories. -The `develop` branches of the repositories will be kept in sync as much as possible -If an interface change in `hed-python` triggers a change in `hed-web` or `hed-examples`, -every effort will be made to get the three types of branches -(`develop`, `latest`, `stable`) of the respective repositories in -sync. - -API documentation is generated on ReadTheDocs when a new version is -pushed on any of the three branches. For example, the API documentation for the -`latest` branch can be found on [hed-python.readthedocs.io/en/latest/](hed-python.readthedocs.io/en/latest/). - -#### To contribute - -Contributions are welcome. -Please use the [Github issues](https://github.com/hed-standard/hed-python/issues) -for suggestions or bug reports. -The [Github pull request](https://github.com/hed-standard/hed-python/pulls) -may also be used for contributions. -These PRs should be made to the `develop` branch, not the `master` branch. - -#### Local Settings Storage -Cached Schemas by default are stored in "home/.hedtools/" -Location of "home" directory varies by OS. - -Use `hed.schema.set_cache_directory` to change the location. -The HED cache can be shared across processes. - -Starting with `hedtools 0.2.0` local copies of the most recent schema versions -are stored within the code modules for easy access. - -### Other links of interest - -Code climate reports: [https://codeclimate.com/github/hed-standard/hed-python](https://codeclimate.com/github/hed-standard/hed-python). +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8056010.svg)](https://doi.org/10.5281/zenodo.8056010) +[![Maintainability](https://api.codeclimate.com/v1/badges/11bf2329590e7b0164ba/maintainability)](https://codeclimate.com/github/hed-standard/hed-python/maintainability) +[![Test Coverage](https://api.codeclimate.com/v1/badges/11bf2329590e7b0164ba/test_coverage)](https://codeclimate.com/github/hed-standard/hed-python/test_coverage) +![Python3](https://img.shields.io/badge/python->=3.8-yellow.svg) +![PyPI - Status](https://img.shields.io/pypi/v/hedtools) +[![Documentation Status](https://readthedocs.org/projects/hed-python/badge/?version=latest)](https://hed-python.readthedocs.io/en/latest/?badge=latest) + +# HEDTools - Python +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. +HED, itself, is platform-independent, extendable, and data-neutral. + +This repository contains the underlying python tools that support validation, +summarization, and analysis of datasets using HED tags. + +Most people will simply annotate their events by creating a spreadsheet +or a BIDS JSON sidecar that associates HED tags with event codes or the events themselves. +If you have such a spreadsheet or a JSON, +you can use the HED Online Validator currently available at +[https://hedtools.org](https://hedtools.org) to validate or transform +your files without downloading any tools. + +A version of the online tools corresponding to the `develop` branch can be found at: +[https://hedtools.org/hed_dev](https://hedtools.org/hed_dev). + +### Installation +Use `pip` to install `hedtools` from PyPI: + + ``` + pip install hedtools + ``` + +To install directly from the +[GitHub](https://github.com/hed-standard/hed-python) repository `master` branch: + + ``` + pip install git+https://github.com/hed-standard/hed-python/@master + ``` + +The HEDTools in this repository require Python 3.8 or greater. + +### Relationship to other repositories + +The `hed-python` repository contains the Python infrastructure for validating +and analyzing HED. This repository has several companion repositories: +- [`hed-web`](https://github.com/hed-standard/hed-web) contains the web interface +for HED as well as a deployable docker module that supports web services for HED. +- [`hed-examples`](https://github.com/hed-standard/hed-examples) contains examples of +using HED in Python and MATLAB. This repository also houses the HED resources. +See [https://www.hed-resources.org](https://www.hed-resources.org) for access to these. +- [`hed-specification`](https://github.com/hed-standard/hed-specification) contains +the HED specification documents. The `hed-python` validator is keyed to error codes +in this document. +- [`hed-schemas`](https://github.com/hed-standard/hed-schemas) contains +the official HED schemas. The tools access this repository to retrieve and cache schema versions +during execution. Starting with `hedtools 0.2.0` local copies of the most recent schema versions +are stored within the code modules for easy access. + +#### Develop versus master versus stable branches + +The `hed-python` repository + +| Branch | Meaning | Synchronized with | +| ------ | -------- | ------------------ | +| stable | Officially released on PyPI as a tagged version. | `stable@hed-web`
`stable@hed-specification`
`stable@hed-examples` | +| latest | Most recent usable version. | `latest@hed-web`
`latest@hed-specification`
`latest@hed-examples` | +| develop | Experimental and evolving. | `develop@hed-web`
`develop@hed-specification`
`develop@hed-examples` | + +As features are integrated, they first appear in the `develop` branches of the +repositories. +The `develop` branches of the repositories will be kept in sync as much as possible +If an interface change in `hed-python` triggers a change in `hed-web` or `hed-examples`, +every effort will be made to get the three types of branches +(`develop`, `latest`, `stable`) of the respective repositories in +sync. + +API documentation is generated on ReadTheDocs when a new version is +pushed on any of the three branches. For example, the API documentation for the +`latest` branch can be found on [hed-python.readthedocs.io/en/latest/](hed-python.readthedocs.io/en/latest/). + +#### To contribute + +Contributions are welcome. +Please use the [Github issues](https://github.com/hed-standard/hed-python/issues) +for suggestions or bug reports. +The [Github pull request](https://github.com/hed-standard/hed-python/pulls) +may also be used for contributions. +These PRs should be made to the `develop` branch, not the `master` branch. + +#### Local Settings Storage +Cached Schemas by default are stored in "home/.hedtools/" +Location of "home" directory varies by OS. + +Use `hed.schema.set_cache_directory` to change the location. +The HED cache can be shared across processes. + +Starting with `hedtools 0.2.0` local copies of the most recent schema versions +are stored within the code modules for easy access. + +### Other links of interest + +Code climate reports: [https://codeclimate.com/github/hed-standard/hed-python](https://codeclimate.com/github/hed-standard/hed-python).