Skip to content

Commit

Permalink
Update version details for the 2.1.0 release, which comes with Python…
Browse files Browse the repository at this point in the history
… 3 support.
  • Loading branch information
matthewwardrop committed Dec 8, 2015
1 parent 6ccbe32 commit 2ac4147
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ParamPy
=======

`parampy` is a Python2 (Python 3 is not supported `*`) module that abstracts the management of model parameters. It can:
`parampy` is a Python 2/3* module that abstracts the management of model parameters. It can:

- Simplify the storage and retrieval of model parameters.
- Keep track of parameter units, and perform unit conversions where that makes sense. It is also possible to provide/override unit definitions and conversions.
Expand All @@ -14,7 +14,7 @@ ParamPy
- Simplify parameters based upon whether or not certain parameters can be assumed to be fixed.
- Run with low overhead so it is suitable for use in simulations in which parameters will be evaluated millions of times.

As of version 2.0.0 (the version at time of writing), simple parameter storage and extraction is only a factor of 8 ± 1 times slower than simply setting and reading a python variable; though this increases when more advanced features are used. As a result, ParamPy ought not to be the bottleneck in simulations.
As of version 2.1.0 (the version at time of writing), simple parameter storage and extraction is only a factor of 8 ± 1 times slower than simply setting and reading a python variable (under Python 2*); though this increases when more advanced features are used. As a result, ParamPy ought not to be the bottleneck in simulations.

Most of the above features are thoroughly documented and unittested. Refer to `documentation.pdf` for more details.

Expand All @@ -27,10 +27,10 @@ If you use `pip`, you can run:

Otherwise, installing this module is as easy as:

$ python2 setup.py install
$ python setup.py install

If you run Arch Linux, you can instead run:

$ makepkg -i

`*` A port of `parampy` to Python 3 exists as a branch, but its performance is slightly worse than in Python 2. For this reason, it has not yet been pushed to the master branch.
`*` Python 3 support is new as of version 2.1.0 . ParamPy currently runs a little slower under Python 3 compared to Python 2.
6 changes: 3 additions & 3 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Introduction

Keeping track of parameters during simulations can often be cumbersome,
especially if those parameters are time- or co- dependent, or if unit
conversions are necessary. `parampy` is a Python2 (Python 3 is not supported `*`) module
conversions are necessary. `parampy` is a Python 2/3* module
that abstracts the management of model parameters. It can:

- Simplify the storage and retrieval of model parameters.
Expand All @@ -17,8 +17,8 @@ that abstracts the management of model parameters. It can:
- Simplify parameters based upon whether or not certain parameters can be assumed to be fixed.
- Run with low overhead so it is suitable for use in simulations in which parameters will be evaluated millions of times.

As of version 2.0.0 (the version at time of writing), simple parameter storage and extraction is only a factor of 8 ± 1 times slower than simply setting and reading a python variable; though this increases when more advanced features are used. As a result, ParamPy ought not to be the bottleneck in simulations.
As of version 2.1.0 (the version at time of writing), simple parameter storage and extraction is only a factor of 8 ± 1 times slower than simply setting and reading a python variable (for Python 2*); though this increases when more advanced features are used. As a result, ParamPy ought not to be the bottleneck in simulations.

Most of the above features are thoroughly documented and unittested. Refer to `documentation.pdf` for more details.

`*`: A port of `parampy` to Python 3 exists as a branch, but its performance is slightly worse than in Python 2. For this reason, it has not yet been pushed to the master branch.
`*`: Python 3 support is new as of version 2.1.0 . ParamPy currently runs a little slower under Python 3 compared to Python 2.
Binary file modified documentation.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions parampy/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
__author__ = 'Matthew Wardrop'
__author_email__ = 'mister dot <surname> at gmail'
__version__ = '2.0.1'
__author_email__ = 'mister.wardrop@gmail.com'
__version__ = '2.1.0'

import pyximport; pyximport.install()

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
]

setup(name='parampy',
version='2.0.1',
version='2.1.0',
description='A parameter manager that keeps track of physical (or numerical) quantities, and the relationships between them.',
author='Matthew Wardrop',
author_email='[email protected]',
Expand Down

0 comments on commit 2ac4147

Please sign in to comment.