Welcome to PyPsych’s documentation!

Contents:

PyPsych

https://travis-ci.org/janmtl/pypsych.png?branch=master https://pypip.in/d/pypsych/badge.png

Data-crunching automation for psychology experiments (SMI BeGaze, Biopac,...)

Features

  • TODO

Installation

At the command line:

$ pip install pypsych

Usage

At it’s core, pypsych is a tool that performs one function: it takes in physiological data from a psychology experiment and a human-readable description of the experiment and then processes and collates all of the data for further analysis. Possible output formats include pandas dataframes (when pypsych is used inside a python script), csv/tsv files, and excel files.

To use PyPsych in a project:

import pypsych

Contributing

Note: make sure you don’t create namespace conflicts when returning channels from data sources.

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/janmtl/pypsych/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” is open to whoever wants to implement it.

Implement Features

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

Write Documentation

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

  1. Fork the pypsych repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/pypsych.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 pypsych
$ cd pypsych/
$ 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:

    $ flake8 pypsych tests
$ python setup.py test
$ tox

    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.6, 2.7, 3.3, and 3.4, and for PyPy. Check https://travis-ci.org/janmtl/pypsych/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_pypsych

Credits

Development Lead

History

0.0.1 (2015-02-20)

  • First release on PyPI.

Indices and tables