Skip to main content

Reblocking analysis tools for correlated data

Project description

pyblock is a python module for performing a reblocking analysis on serially-correlated data.

The algorithms implemented in pyblock are not new; please see the documentation for references.

pyblock is compatible with (and tested on!) python 2.7 and python 3.3-3.4 and should work on any other version supported by pandas.

https://travis-ci.org/jsspencer/pyblock.svg?branch=master

Documentation

Documentation and a simple tutorial can be found in the docs subdirectory and on readthedocs.

Installation

pyblock can be used simply by adding to $PYTHONPATH. Alternatively, it can be installed using distutils by running:

$ pip install /path/to/pyblock

where /path/to/ is the (relative or absolute) path to the directory containing pyblock. To install an editable version (useful for development work) do:

$ pip install -e /path/to/pyblock

pyblock can also be installed from PyPI:

$ pip install pyblock

pyblock requires numpy and (optionally) pandas and matplotlib. Please see the documentation for more details.

License

Modified BSD license; see LICENSE for more details.

Please cite pyblock, James Spencer, http://github.com/jsspencer/pyblock if used to analyse data for an academic publication.

Author

James Spencer, Imperial College London

Contributing

Contributions are extremely welcome, either by raising an issue or contributing code. For code contributions, please try to follow the following points:

  1. Divide commits into logical units (e.g. don’t mix feature development with refactoring).

  2. Ensure all existing tests pass.

  3. Create tests for new functionality. I aim for complete test coverage. (Currently the only function not tested is one that creates plots.)

  4. Write nice git commit messages (see Tim Pope’s advice.)

  5. Send a pull request!

Acknowledgments

Will Vigor (Imperial College London) pointed out and wrote an early implementation of the algorithm to detect the optimal reblock length.

Tom Poole (Imperial College London) contributed code to handle weighted averages.

The HANDE FCIQMC/CCMC development team made several helpful comments and suggestions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyblock-0.6.tar.gz (15.9 kB view details)

Uploaded Source

File details

Details for the file pyblock-0.6.tar.gz.

File metadata

  • Download URL: pyblock-0.6.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.1

File hashes

Hashes for pyblock-0.6.tar.gz
Algorithm Hash digest
SHA256 04b139b86af7e90fe8fe31f63548a585f939458d884c492ab9438baad5ec63e4
MD5 acc0afab689f7e46cef55bbaa15bdfd5
BLAKE2b-256 3a8f1b6fe04f4834dfa95f6e37881b61b2fc9e0652ea3d0771243728c11287f8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page