update version

Author: bobmyhill

README.md

@@ -1,3 +1,5 @@
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6528718.svg)](https://doi.org/10.5281/zenodo.6528718)
+
 # pyeq3: an equation, curve and surface fitting library
 
 <p align="center">

changelog.txt

@@ -0,0 +1,10 @@
+Changelog
+---------
+
+Release v12.6.0 (May 8, 2022)
+  - Code restructured and reformatted
+  - Updates to code to for use with Python 3.9+
+  - Adds ability to add data as a numpy array
+  - Adds string output to the IModel class
+  - Fixes solved coefficients output for fixed or bounded solutions
+  - Adds basic sphinx documentation

pyeq3/__init__.py

@@ -4,46 +4,50 @@
 #    2548 Vera Cruz Drive
 #    Birmingham, AL 35235 USA
 #
-#    email: [email protected]
-#
-#    License: BSD-style (see LICENSE.txt in main source directory)
+#    License: BSD-style (see license.txt in main source directory)
 """
 Introducing pyeq3 |version|
 ===========================
 
 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.
+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.
+pyeq3 is released under a permissive license.
+It relies on numpy, scipy, and matplotlib.
 
- - Homepage: https://github.com/bobmyhill/pyeq3
+ - Homepage: https://github.com/equations-project/pyeq3
  - Documentation: http://pyeq3.readthedocs.io
- - Source code: https://github.com/bobmyhill/pyeq3
+ - Source code: https://github.com/equations-project/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 :ref:`ref-installation` for detailed
-instructions. After that, you might want to try out some :ref:`ref-examples`.
+If you haven't yet installed pyeq3, you can go straight to
+:ref:`ref-installation` for detailed instructions.
+After that, you might want to try out some :ref:`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.
+If you use pyeq3 in your work, we ask that you cite the following publications:
+  - Phillips, J. R. and Myhill, R. (2022):
+    pyeq3 v12.6 [Software]. Zenodo.
+    `(https://doi.org/10.5281/zenodo.6528718) <https://doi.org/10.5281/zenodo.6528718>`_
 
 
 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 <https://github.com/bobmyhill/pyeq3/pulls>`_.
+pull request at `https://github.com/equations-project/pyeq3/pulls <https://github.com/equations-project/pyeq3/pulls>`_.
 
 
 .. _ref-installation:
@@ -59,8 +63,9 @@
 ------------
 
 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.
+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
 ^^^^^^^^^^^^
@@ -92,22 +97,22 @@
 
 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.
+be downloaded from https://github.com/equations-project/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).
+(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
+    git clone https://github.com/equations-project/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.)
+from https://github.com/equations-project/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:

pyeq3/version.py

@@ -1,2 +1,2 @@
-version = '12.5.2pre'
-short_version = '12.5.2'
+version = '12.6'
+short_version = '12.6'

setup.py

@@ -1,10 +1,10 @@
-from setuptools import setup, find_packages  # Always prefer setuptools over distutils
+from setuptools import find_packages
 from codecs import open  # To use a consistent encoding
 from os import path
 import re
 
-versionstuff = dict(
-    re.findall("(.+) = '(.+)'\n", open('pyeq3/version.py').read()))
+versionstuff = dict(re.findall("(.+) = '(.+)'",
+                               open('pyeq3/version.py').read()))
 
 here = path.abspath(path.dirname(__file__))