Welcome to ceedub’s documentation!

Contents:

ceedub

py27 py35 py36

PyPI status Build Status Documentation Status Developement Tool Updates

An awesome, simple, and easy to use continuous wavelet transform package for python!

To install the latest stable release v0.1.0 -- alpha from PyPI run:

pip install ceedub

To install the most current version with pip directly from github run:

pip install git+https://github.com/paulthebaker/ceedub@master

Features

  • continuous wavelet transforms (forward and inverse) in python
  • arbitrary user defined wavelet basis functions (provides Morlet-Gabor and Paul wavelets)
  • follows the conventions of Torrence and Compo [TC1998].
[TC1998]https://doi.org/10.1175/1520-0477(1998)079<0061:APGTWA>2.0.CO;2

Credits

Copyright (c) 2017 Paul T. Baker

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install the ceedub, run this command in your terminal:

$ pip install ceedub

This is the preferred method to install ceedub, 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 ceedub can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/paulthebaker/ceedub

Or download the tarball:

$ curl  -OL https://github.com/paulthebaker/ceedub/tarball/master

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

$ python setup.py install

Usage

To use ceedub in a project:

import ceedub

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/paulthebaker/ceedub/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

ceedub could always use more documentation, whether as part of the official ceedub 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/paulthebaker/ceedub/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 ceedub for local development.

  1. Fork the ceedub repo on GitHub.

  2. Clone your fork locally:

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

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv ceedub
$ cd ceedub/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox. These are implemented in the Makefile:

    $ make lint
$ make docs
$ make test

    To get flake8 and tox, just pip install them into your virtualenv.

  6. 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

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

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

  1. The pull request should include tests.
  2. 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.rst.
  3. The pull request should work for Python 2.7, 3.5 and 3.6. Check https://travis-ci.org/paulthebaker/ceedub/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_ceedub

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.1.0 (2017-09-19)

  • First release on PyPI.

0.0.0 (2017-09-18)

  • initial release

Indices and tables