Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/bjodah/pykinsol

Python wrapper around KINSOL (from the sundials library)

https://github.com/bjodah/pykinsol

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.0%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Python wrapper around KINSOL (from the sundials library)

Basic Info
  • Host: GitHub
  • Owner: bjodah
  • License: bsd-2-clause
  • Language: C++
  • Default Branch: master
  • Homepage:
  • Size: 6.56 MB
Statistics
  • Stars: 10
  • Watchers: 2
  • Forks: 3
  • Open Issues: 1
  • Releases: 7
Created over 10 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License Authors

README.rst 

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 `_ provides a
`Python `_ binding to the
`Nonlinear system of equation `_
solver algorithms from `kinsol `_ in the
`SUNDIALS suite `_. ``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 `_
which can e.g. derive the Jacobian analytically for you.


Documentation
-------------
Autogenerated API documentation is found `here `_.

Installation
------------
Simplest way to install pykinsol is to use the
`conda package manager `_:

::

   $ conda install -c bjodah pykinsol pytest
   $ python -m pytest --pyargs pykinsol

tests should pass.

Binary distribution is available here:
``_

Source distribution is available here:
``_

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/ `_, and rendered jupyter notebooks here:
``_

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 `_ for further details.

Contributors are welcome to suggest improvements at https://github.com/bjodah/pykinsol

Author
------
Björn I. Dahlgren, contact:

- gmail address: bjodah

Owner

  • Name: Bjorn
  • Login: bjodah
  • Kind: user

GitHub Events

Total
  • Release event: 1
  • Push event: 14
  • Pull request event: 2
  • Create event: 2
Last Year
  • Release event: 1
  • Push event: 14
  • Pull request event: 2
  • Create event: 2

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 44
  • Total Committers: 1
  • Avg Commits per committer: 44.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Björn Dahlgren b****h@g****m 44

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 2
  • Total pull requests: 11
  • Average time to close issues: 2 days
  • Average time to close pull requests: about 1 month
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • yurivict (1)
  • bjodah (1)
Pull Request Authors
  • bjodah (11)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 157 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 2
  • Total versions: 10
  • Total maintainers: 1
pypi.org: pykinsol

pykinsol provides a Python interface to KINSOL from the SUNDIALS package suite.

  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 157 Last month
Rankings
Dependent packages count: 10.1%
Dependent repos count: 11.6%
Forks count: 16.8%
Average: 17.7%
Stargazers count: 17.7%
Downloads: 32.2%
Maintainers (1)
bjodah
Last synced: 11 months ago

Dependencies

setup.py pypi
  • numpy *