Permalink
Browse files

Merge pull request #6 from SimonGreenhill/master

Merge HACKING.rst fixes from Simon Greenhill. Thanks!
  • Loading branch information...
2 parents 2f4c63e + ad881c7 commit 959edc8995dea68a80746e2531089d8cadb91c72 @strohel committed Feb 23, 2012
Showing with 14 additions and 13 deletions.
  1. +11 −10 HACKING.rst
  2. +3 −3 README.rst
View
@@ -16,9 +16,9 @@ PyBayes modules are laid out with following rules:
* all modules go directly into ``pybayes/<module>.py`` (pure Python file) with
cython augmentation file in ``pybayes/module.pxd``
* in future, bigger independent units can form subpackages
-* ``pybayes/wapperts/`` subpackage is special, it is the only package whose modules
- have different implementation for cython and for python. It is accomplished by .py (Python) and
- .pyx, .pxd (Cython) files.
+* ``pybayes/wrappers/`` subpackage is special, it is the only package whose
+ modules have different implementation for cython and for python. It is
+ accomplished by .py (Python) and .pyx, .pxd (Cython) files.
Tests and Stress Tests
======================
@@ -34,18 +34,19 @@ Imports and cimports
====================
**No internal module** can ``import pybayes``! That would result in an infinite
-recursion. External PyBayes clients can and should, however, only ``import pybayes``
-(and in future also ``import pybayes.subpackage``). From insibe PyBayes just
-import relevant pybayes modules, e.g. ``import pdfs``. Notable exception from this rule is cimport,
-where (presumable due to a cython bug) ``from a.b cimport c`` sometimes doesn't work and one has
-to type ``from pybayes.a.b cimport c``.
+recursion. External PyBayes clients can and should, however, only ``import
+pybayes`` (and in future also ``import pybayes.subpackage``). From inside
+PyBayes just import relevant pybayes modules, e.g. ``import pdfs``. Notable
+exception from this rule is cimport, where (presumable due to a cython bug)
+``from a.b cimport c`` sometimes doesn't work and one has to type ``from
+pybayes.a.b cimport c``.
Imports in \*.py files should adhere to following rules:
* import first system modules (sys, io..), then external modules (matplotlib..)
and then pybayes modules.
-* **instead of** importing **numpy** directly use ``import wrappers._numpy as np``. This ensures
- that fast C alternatives are used in compiled mode.
+* **instead of** importing **numpy** directly use ``import wrappers._numpy as np``.
+ This ensures that fast C alternatives are used in compiled mode.
* **instead of** importing **numpy.linalg** directly use ``import wrappers._linalg as linalg``.
* use ``import module [as abbrev]`` or, for commonly used symbols ``from module import symbol``.
* ``from module import *`` shouldn't be used.
View
@@ -9,10 +9,10 @@ PyBayes is an object-oriented Python library for recursive Bayesian
estimation (Bayesian filtering) that is convenient to use. Already implemented are
Kalman filter, particle filter and marginalized particle filter, all built atop of
a light framework of probability density functions. PyBayes can optionally use Cython
-for lage speed gains (Cython build can be several times faster in some situations).
+for large speed gains (Cython build can be several times faster in some situations).
-PyBayes is tested with Python 2.6, 2.7 and 3.1 (using 2to3). Future plans include more specialised
-variants of Kalman/particle filters and speed optimisations.
+PyBayes is tested with Python 2.6, 2.7 and 3.1 (using 2to3). Future plans include
+more specialised variants of Kalman/particle filters and speed optimisations.
PyBayes is being developed by Matěj Laitl, feel free to send me a mail to matej at laitl dot cz.
See ChangeLog.rst file to review a list of most important changes in recent versions.

0 comments on commit 959edc8

Please sign in to comment.