Platea is a passion project of mine. While working to optimize code for my day job as a Data Scientist, I began exploring the wonderful worlds of C++ and Fortran. I became very interested in learning how to implement numerical methods at a low level and in a performant manner. This code is a product of that work.
I'm open to all questions, feedback, commentary, and suggestions as long as they are constructive and polite! Discussions should always come in the form of git issues.
One of the big design philosophy differences between this package and packages like numpy is that this package is not made to be fool proof. For example, there are functions where we assume that users will read the docs and input appropriate arguments. We have intentionally left out assertions to check if these arguments conform to the docs. This reduces run times, but it also removes a safety net that many python users rely on.
James Montgomery - Initial work - jamesmontgomery.us
This project is licensed under the MIT License - see the LICENSE.md file for details
Why name a statistics package Platea? In addition to being a stats nerd I am also a history wonk. When writing this package I was reminded of a story in Thucydides' "History of the Peloponnesian War" where the Athenians needed to estimate the height of the walls surrounding Platea in order to know how high to make their siege ladders. The Athenians counted the number of bricks at a number of unplastered sections of wall and used the mode of these counts and the estimated height of a brick to approximate the height of the walls. This is one of the earliest recorded applications of "statistics" (5th Century BC).
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
For a local installation, first git clone this repository. Then follow these instructions:
pip install .
To install from pypi:
pip install -U platea
Testing is an important part of creating maintainable, production grade code. Below are instructions for running unit and style tests as well as installing the necessary testing packages. Tests have intentionally been separated from the installable pypi package for a variety of reasons.
Make sure you have the required testing packages:
pip install -r requirements_test.txt
You will also need to build the package extensions in place:
python setup.py build_ext --inplace
We use the pytest framework for unit testing.
pytest -vvl -s --cov platea --disable-pytest-warnings
Having neat and legible code is important. Having documentation is also important. We use pylint as our style guide framework. Many of our naming conventions follow directly from the literary sources they come from. This makes it easier to read the mathematical equations and see how they translate into the code. This sometimes forces us to break pep8 conventions for naming.
pylint platea --disable=invalid-name
Here are some basic guidelines for contributing.
This repository doesn't use a complicated branching strategy. Simply create a feature branch off of master. When the feature is ready to be integrated with master, submit a pull request. A pull request will re quire at least one peer review and approval from the repository owner.
Please stick to pep8 standards when for your code. Use numpy style docstrings.
Please use pytest as your testing suite. You code should have >= 80% coverage.
Updating the documentation is simple. First build the package extensions in place by running the code below in the repository root directory. This is required for Sphinx auto-docs to work correctly.
python setup.py build_ext --inplace
Then let auto-docs check for updates to the package structure.
cd docs
sphinx-apidoc -o . ../platea/
Finally, rebuild the html files.
make html
A big thank you to Keegan Hines who first recommended the book "Numerical Recipes" to me. Another big thank you to Mack Sweeney who has shaped much of my appreciation for code styling and standards. Finally, thanks to Greg Sinclair for being a sounding board and source of advice as I worked on this package.
Book References: