Skip to content

jackrosenthal/aecg-python

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Python tools for annotated electrocardiogram (aECG) files

Abstract

This python package provides basic functionality to read and index annotated electrocardiogram (aECG) files in HL7 aECG (XML) format. See the TUTORIAL for a quick introduction to examples of use.

See LICENSE and DISCLAIMER at the bottom of this document.

Installing the software

This project uses uv for dependency management.

Installing from source

  • Clone the aecg-python repository:
git clone https://github.com/FDA/aecg-python
cd aecg-python
  • Run the command line tool:
uv run aecg --help
  • Run unit tests:
uv run pytest -v

Development and deployment tips

How to build the package for distribution from the source code

To create a source and wheels distributions:

uv build

How to generate a local copy of the documentation

To generate a local HTML version of the documentation:

cd docs
uv run --group doc sphinx-build . _build

The generated documentation will be in the docs/_build directory.

License

This code is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal Public Domain Dedication. This example is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See DISCLAIMER section below, the COPYING file in the root directory of this project and https://creativecommons.org/publicdomain/zero/1.0/ for more details.

Disclaimer

FDA assumes no responsibility whatsoever for use by other parties of the Software, its source code, documentation or compiled executables, and makes no guarantees, expressed or implied, about its quality, reliability, or any other characteristic. Further, FDA makes no representations that the use of the Software will not infringe any patent or proprietary rights of third parties. The use of this code in no way implies endorsement by the FDA or confers any advantage in regulatory decisions.

About

Fork of FDA/aecg-python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 100.0%