Welcome to tremana’s documentation!

tremana

All Contributors

Medical tremor analysis package (e.g. for parkinsonian tremor)

Free software: Apache Software License 2.0
Documentation: https://tremana.readthedocs.io.

Features

Library with functions for tremor analysis (WIP)
- Accelerometry (WIP)
  - Device raw data reader (WIP)
  - FFT analysis (WIP)
CLI for batch analysis (planned)
Jupyter widgets for interactive analysis (planned)

Installation

Stable release

To install tremana, run this command in your terminal:

$ pip install tremana

This is the preferred method to install tremana, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for tremana can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/s-weigand/tremana

Or download the tarball:

$ curl -OJL https://github.com/s-weigand/tremana/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use tremana in a project:

import tremana

Inner workings

This is the detailed documentation of the inner workings of tremana.

tremana

Top-level package for tremana.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/s-weigand/tremana/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

tremana could always use more documentation, whether as part of the official tremana docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/s-weigand/tremana/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up tremana for local development.

Fork the tremana repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/tremana.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv tremana
$ cd tremana/
$ pip install -e .
```

install the pre-commit and pre-push hooks:

$ pre-commit install && pre-commit install -t pre-push

Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check https://github.com/s-weigand/tremana/actions and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ pytest tests.test_tremana

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bump2version patch # possible: major / minor / patch
$ git push --follow-tags

Travis will then deploy to PyPI if tests pass.

History

0.0.1 (2021-01-24)

First release on PyPI.