pykinsol
========
.. image:: http://hera.physchem.kth.se:9090/api/badges/bjodah/pykinsol/status.svg
:target: http://hera.physchem.kth.se:9090/bjodah/pykinsol
:alt: Build status
.. image:: https://circleci.com/gh/bjodah/pykinsol.svg?style=svg
:target: https://circleci.com/gh/bjodah/pykinsol
:alt: Build status on CircleCI
.. image:: https://secure.travis-ci.org/bjodah/pykinsol.svg?branch=master
:target: http://travis-ci.org/bjodah/pykinsol
:alt: Build status on Travis-CI
.. image:: https://img.shields.io/pypi/v/pykinsol.svg
:target: https://pypi.python.org/pypi/pykinsol
:alt: PyPI version
.. image:: https://img.shields.io/pypi/l/pykinsol.svg
:target: https://github.com/bjodah/pykinsol/blob/master/LICENSE
:alt: License
.. image:: http://hera.physchem.kth.se/~pykinsol/branches/master/htmlcov/coverage.svg
:target: http://hera.physchem.kth.se/~pykinsol/branches/master/htmlcov
:alt: coverage
`pykinsol <https://github.com/bjodah/pykinsol>`_ provides a
`Python <http://www.python.org>`_ binding to the
`Nonlinear system of equation <https://en.wikipedia.org/wiki/Nonlinear_system>`_
solver algorithms from `kinsol <https://computation.llnl.gov/casc/sundials/description/description.html#descr_kinsol>`_ in the
`SUNDIALS suite <https://computation.llnl.gov/casc/sundials/main.html>`_. ``pykinsol`` allows a user to numerically solve
(systems of) non-linear equations. Note that not all functionality of KINSOL are currently exposed in the python wrapper. Additional functionality is however easy to add if needed.
You may also want to know that you can use ``pykinsol`` from
`pyneqsys <https://github.com/bjodah/pyneqsys>`_
which can e.g. derive the Jacobian analytically for you.
Documentation
-------------
Autogenerated API documentation is found `here <http://hera.physchem.kth.se/~pykinsol/branches/master/html>`_.
Installation
------------
Simplest way to install pykinsol is to use the
`conda package manager <http://conda.pydata.org/docs/>`_:
::
$ conda install -c bjodah pykinsol pytest
$ python -m pytest --pyargs pykinsol
tests should pass.
Binary distribution is available here:
`<https://anaconda.org/bjodah/pykinsol>`_
Source distribution is available here:
`<https://pypi.python.org/pypi/pykinsol>`_
To compile from source you may proceed e.g. as follows:
::
$ LLAPACK=openblas python3.4 setup.py install --user
where we specified specifically what LAPACK implementation we used for building SUNDIALS.
Examples
--------
See `examples/ <https://github.com/bjodah/pykinsol/tree/master/examples>`_, and rendered jupyter notebooks here:
`<http://hera.physchem.kth.se/~pykinsol/branches/master/examples>`_
Here is a simple example:
.. code:: python
>>> def f(x, fout):
... fout[0] = x[0] + (x[0] - x[1])**3/2 - 1
... fout[1] = x[1] + (x[1] - x[0])**3/2
...
>>> def j(x, Jout, fx):
... Jout[0, 0] = 1 + 3/2 * (x[0] - x[1])**2
... Jout[0, 1] = -3/2 * (x[0] - x[1])**2
... Jout[1, 0] = -3/2 * (x[1] - x[0])**2
... Jout[1, 1] = 1 + 3/2 * (x[1] - x[0])**2
...
>>> from pykinsol import solve
>>> result = solve(f, j, [0, 0])
>>> assert result['success']
>>> print(result['x']) # doctest: +SKIP
[ 0.84116389 0.15883611]
License
-------
The source code is Open Source and is released under the simplified 2-clause BSD license. See `LICENSE <LICENSE>`_ for further details.
Contributors are welcome to suggest improvements at https://github.com/bjodah/pykinsol
Author
------
Björn I. Dahlgren, contact:
- gmail address: bjodah
Raw data
{
"_id": null,
"home_page": "https://github.com/bjodah/pykinsol",
"name": "pykinsol",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Bjoern I. Dahlgren",
"author_email": "bjodah@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b0/d0/331fdd1b604501854c11ec2451fa7026729a76c5333c15884e18021600b2/pykinsol-0.1.8.tar.gz",
"platform": null,
"description": "pykinsol\n========\n\n.. image:: http://hera.physchem.kth.se:9090/api/badges/bjodah/pykinsol/status.svg\n :target: http://hera.physchem.kth.se:9090/bjodah/pykinsol\n :alt: Build status\n.. image:: https://circleci.com/gh/bjodah/pykinsol.svg?style=svg\n :target: https://circleci.com/gh/bjodah/pykinsol\n :alt: Build status on CircleCI\n.. image:: https://secure.travis-ci.org/bjodah/pykinsol.svg?branch=master\n :target: http://travis-ci.org/bjodah/pykinsol\n :alt: Build status on Travis-CI\n.. image:: https://img.shields.io/pypi/v/pykinsol.svg\n :target: https://pypi.python.org/pypi/pykinsol\n :alt: PyPI version\n.. image:: https://img.shields.io/pypi/l/pykinsol.svg\n :target: https://github.com/bjodah/pykinsol/blob/master/LICENSE\n :alt: License\n.. image:: http://hera.physchem.kth.se/~pykinsol/branches/master/htmlcov/coverage.svg\n :target: http://hera.physchem.kth.se/~pykinsol/branches/master/htmlcov\n :alt: coverage\n\n\n`pykinsol <https://github.com/bjodah/pykinsol>`_ provides a\n`Python <http://www.python.org>`_ binding to the\n`Nonlinear system of equation <https://en.wikipedia.org/wiki/Nonlinear_system>`_\nsolver algorithms from `kinsol <https://computation.llnl.gov/casc/sundials/description/description.html#descr_kinsol>`_ in the\n`SUNDIALS suite <https://computation.llnl.gov/casc/sundials/main.html>`_. ``pykinsol`` allows a user to numerically solve\n(systems of) non-linear equations. Note that not all functionality of KINSOL are currently exposed in the python wrapper. Additional functionality is however easy to add if needed.\n\nYou may also want to know that you can use ``pykinsol`` from\n`pyneqsys <https://github.com/bjodah/pyneqsys>`_\nwhich can e.g. derive the Jacobian analytically for you.\n\n\nDocumentation\n-------------\nAutogenerated API documentation is found `here <http://hera.physchem.kth.se/~pykinsol/branches/master/html>`_.\n\nInstallation\n------------\nSimplest way to install pykinsol is to use the\n`conda package manager <http://conda.pydata.org/docs/>`_:\n\n::\n\n $ conda install -c bjodah pykinsol pytest\n $ python -m pytest --pyargs pykinsol\n\ntests should pass.\n\nBinary distribution is available here:\n`<https://anaconda.org/bjodah/pykinsol>`_\n\nSource distribution is available here:\n`<https://pypi.python.org/pypi/pykinsol>`_\n\nTo compile from source you may proceed e.g. as follows:\n\n::\n\n $ LLAPACK=openblas python3.4 setup.py install --user\n\nwhere we specified specifically what LAPACK implementation we used for building SUNDIALS.\n\nExamples\n--------\nSee `examples/ <https://github.com/bjodah/pykinsol/tree/master/examples>`_, and rendered jupyter notebooks here:\n`<http://hera.physchem.kth.se/~pykinsol/branches/master/examples>`_\n\nHere is a simple example:\n\n.. code:: python\n\n >>> def f(x, fout):\n ... fout[0] = x[0] + (x[0] - x[1])**3/2 - 1\n ... fout[1] = x[1] + (x[1] - x[0])**3/2\n ... \n >>> def j(x, Jout, fx):\n ... Jout[0, 0] = 1 + 3/2 * (x[0] - x[1])**2\n ... Jout[0, 1] = -3/2 * (x[0] - x[1])**2 \n ... Jout[1, 0] = -3/2 * (x[1] - x[0])**2 \n ... Jout[1, 1] = 1 + 3/2 * (x[1] - x[0])**2\n ...\n >>> from pykinsol import solve\n >>> result = solve(f, j, [0, 0])\n >>> assert result['success']\n >>> print(result['x']) # doctest: +SKIP\n [ 0.84116389 0.15883611]\n\n\nLicense\n-------\nThe source code is Open Source and is released under the simplified 2-clause BSD license. See `LICENSE <LICENSE>`_ for further details.\n\nContributors are welcome to suggest improvements at https://github.com/bjodah/pykinsol\n\nAuthor\n------\nBj\u00f6rn I. Dahlgren, contact:\n\n- gmail address: bjodah\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "pykinsol provides a Python interface to KINSOL from the SUNDIALS package suite.",
"version": "0.1.8",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "644bcad62d50f7b7b56a32d8f352f99d",
"sha256": "b7e49ef416838c3fb5d30dbec3c11617ad62b36c1ffddbfbb012c187ec3dbc23"
},
"downloads": -1,
"filename": "pykinsol-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "644bcad62d50f7b7b56a32d8f352f99d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 80781,
"upload_time": "2022-12-05T10:39:26",
"upload_time_iso_8601": "2022-12-05T10:39:26.658209Z",
"url": "https://files.pythonhosted.org/packages/b0/d0/331fdd1b604501854c11ec2451fa7026729a76c5333c15884e18021600b2/pykinsol-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-05 10:39:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "bjodah",
"github_project": "pykinsol",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "pykinsol"
}
JSON
