Introducing pyeq3 12.5.2¶

Overview¶

pyeq3 is a large collection of python3 equations that perform curve fitting on 2D and 3D data, output source code in several computing languages, and run a genetic algorithm for initial parameter estimation. The module comes with cluster, parallel, IPython, GUI, NodeJS, and web-based graphical examples. It includes orthogonal distance and relative error regressions.

pyeq3 is released under a permissive license. It relies on numpy, scipy, and matplotlib.

Homepage: https://github.com/bobmyhill/pyeq3

Documentation: http://pyeq3.readthedocs.io

Source code: https://github.com/bobmyhill/pyeq3

Web App: http://findcurves.com/

Discussion group: https://groups.google.com/g/findcurves

If you haven’t yet installed pyeq3, you can go straight to Requirements for detailed instructions. After that, you might want to try out some ref-examples.

Citing pyeq3¶

There will soon be a Zenodo DOI with which you can cite this project. Please check back here before you publish.

Contributing to pyeq3¶

If you would like to contribute bug fixes, new functions or new modules to the existing codebase, please make a pull request at https://github.com/bobmyhill/pyeq3/pulls.

Requirements¶

Python 3.7+

Python modules: NumPy, SciPy, Matplotlib

Installation¶

Installation of pyeq3 is mostly platform independent. As long as you know how to use a terminal, the process should be straightforward. The following instructions should help, but let us know if you have any problems.

Dependencies¶

First, make sure you have a sufficiently recent version of python installed on your machine (see above for the latest requirements). To check your version of python, type the following in a terminal:

python –version

If your version is not recent enough, visit https://www.python.org/ to find out how to install a newer version.

Once you have checked your version of python, you should make sure you have installed the python module pip. We will use this module to install BurnMan. If you don’t have it already, you can install it by opening a terminal window and typing:

python -m ensurepip –upgrade

Mac users will also need to install Xcode, which can be found in the MacStore.

Stable version¶

If you are only interested in using pyeq3 (rather than developing the software), and you aren’t interested in any of the latest changes, you can install the stable version by typing the following into a terminal window:

python -m pip install pyeq3

This method of installation does not give you easy access to all the examples, or the test suite. These can be found in the latest release package which can be downloaded from https://github.com/bobmyhill/pyeq3/releases.

Development version¶

If you want to install the development version of pyeq3 (with all the latest features), you will first need to download the source code. The best way to do this is by using git (a version control system). To install git, follow the instructions at https://git-scm.com/downloads.

Then, using a terminal, navigate to the directory into which you want to clone the BurnMan repository, and type

git clone https://github.com/bobmyhill/pyeq3.git

(If you don’t want to use git, you can download the current main branch from https://github.com/bobmyhill/pyeq3/archive/main.zip.)

Once the repository is cloned, navigate to the top-level directory by typing cd pyeq3 in the terminal, and then install pyeq3, either in static mode: python -m pip install . or in development mode (if you want to develop or modify the code): python -m pip install -e ..

Checking that the installation worked¶

To check that the installation has worked, navigate to the examples directory and try running the examples:

python <example-name>.py

Acknowledgement and Support¶

This project was created by James R. Phillips. Almost all the functionality was created by him, as are most of the explanatory comments throughout the code.

Ross Moffett is webmaster and maintainer of http://www.findcurves.com, a clone of James’ original web app.