README - PyPedal Version 2.0.4
-------------------------------------------------

WHAT IS PyPedal?

PyPedal is a Python package for pedigree analysis.  PyPedal is a research tool
for the use of the author and any others who might be interested in its use. It
was originally developed by John B. Cole, and may be freely (re)distributed.

DOCUMENTATION

Limited (read preliminary) documentation is available in TeX and Postscript
format in this repository. An HTML version of the manual also may be found at:
http://pypedal.sourceforge.net/.

INSTALLING PyPedal

You should be able to use the usual setup.py installer that's included in the
download.

You must have Python 2.7 (or later) installed in order to use PyPedal. PyPedal
depends on features in 2.7 that are not present in earlier versions of Python.
You may find Python for your operating system at: http://www.python.org/.

You must have the NumPy extension to Python installed.  You can obtain NumPy as
well as installation instructions, at: http://www.numpy.org/.

I've successfully used PyPedal in various flavors of RedHat Linux (including
RHEL), Mandrake Linux, CentOS, and macOS (including Big Sur). I don't routinely
use Windows, so I'm afraid I can't be too much help there.

REPORTING BUGS

To report a bug in PyPedal, please open an issue on GitHub:
https://github.com/wintermind/pypedal.

For general support and questions, please e-mail the author at
john.b.cole@gmail.com.


TRADEMARKS

Microsoft and Windows are registered trademarks of Microsoft Corporation. UNIX
is a registered trademark of the X/Open Group, Inc.  Linux is a registered
trademark of Linus Torvalds.


COPYRIGHT

PyPedal is copyright 2001-2022 by John B. Cole (john.b.cole@gmail.com;
http://johnbcole.com/).

LICENSING

PyPedal is available under the terms of the GNU Library General Public License
v2.0.