Skip to content

Commit

Permalink
Merge pull request #29 from nschloe/upd
Browse files Browse the repository at this point in the history
small updates
  • Loading branch information
nschloe committed Dec 21, 2021
2 parents 3ea0ca9 + 354702b commit b727121
Show file tree
Hide file tree
Showing 5 changed files with 140 additions and 93 deletions.
27 changes: 14 additions & 13 deletions README.md
@@ -1,14 +1,14 @@
# pacopy

[![PyPi Version](https://img.shields.io/pypi/v/pacopy.svg?style=flat-square)](https://pypi.org/project/pacopy)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/pacopy.svg?style=flat-square)](https://pypi.org/pypi/pacopy/)
[![PyPi Version](https://img.shields.io/pypi/v/pacopy.svg?style=flat-square)](https://pypi.org/project/pacopy/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/pacopy.svg?style=flat-square)](https://pypi.org/project/pacopy/)
[![GitHub stars](https://img.shields.io/github/stars/nschloe/pacopy.svg?style=flat-square&logo=github&label=Stars&logoColor=white)](https://github.com/nschloe/pacopy)
[![PyPi downloads](https://img.shields.io/pypi/dm/pacopy.svg?style=flat-square)](https://pypistats.org/packages/pacopy)

[![Discord](https://img.shields.io/static/v1?logo=discord&logoColor=white&label=chat&message=on%20discord&color=7289da&style=flat-square)](https://discord.gg/hnTJ5MRX2Y)

[![gh-actions](https://img.shields.io/github/workflow/status/nschloe/pacopy/ci?style=flat-square)](https://github.com/nschloe/pacopy/actions?query=workflow%3Aci)
[![codecov](https://img.shields.io/codecov/c/github/nschloe/pacopy.svg?style=flat-square)](https://codecov.io/gh/nschloe/pacopy)
[![codecov](https://img.shields.io/codecov/c/github/nschloe/pacopy.svg?style=flat-square)](https://app.codecov.io/gh/nschloe/pacopy)
[![LGTM](https://img.shields.io/lgtm/grade/python/github/nschloe/pacopy.svg?style=flat-square)](https://lgtm.com/projects/g/nschloe/pacopy)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)

Expand All @@ -17,7 +17,7 @@ continuation](https://en.wikipedia.org/wiki/Numerical_continuation) for ODEs and
Python.

pacopy is backend-agnostic, so it doesn't matter if your problem is formulated with
[NumPy](https://numpy.org/), [SciPy](https://www.scipy.org/),
[NumPy](https://numpy.org/), [SciPy](https://scipy.org/),
[FEniCS](https://fenicsproject.org/), [pyfvm](https://github.com/nschloe/pyfvm), or any
other Python package. The only thing the user must provide is a class with some simple
methods, e.g., a function evaluation `f(u, lmbda)`, a Jacobian a solver
Expand All @@ -31,7 +31,7 @@ pip install pacopy
To get started, take a look at the examples below.

Some pacopy documentation is available
[here](https://pacopy.readthedocs.org/en/latest/?badge=latest).
[here](https://pacopy.readthedocs.io/en/latest/?badge=latest).

### Examples

Expand Down Expand Up @@ -278,21 +278,22 @@ def callback(k, lmbda, sol):
# Natural parameter continuation
# pacopy.natural(problem, u0, lmbda0, callback, max_steps=100)

pacopy.euler_newton(problem, u0, lmbda0, callback, max_steps=500, newton_tol=1.0e-10)
pacopy.euler_newton(
problem, u0, lmbda0, callback, max_steps=500, max_num_retries=10, newton_tol=1.0e-10
)
```

#### Ginzburg–Landau

https://user-images.githubusercontent.com/181628/146639709-90b6e6aa-48ba-418d-9aa4-ec5754f95b93.mp4

The [Ginzburg-Landau
equations](https://en.wikipedia.org/wiki/Ginzburg%E2%80%93Landau_theory) model the
behavior of extreme type-II superconductors under a magnetic field. The above example
(to be found in full detail
[here](https://github.com/nschloe/pacopy/blob/master/test/test_ginzburg_landau.py))
shows parameter continuation in the strength of the magnetic field. The plot on the
right-hand side shows the complex-valued solution using
[cplot](https://github.com/nschloe/cplot).
equations](https://en.wikipedia.org/wiki/Ginzburg%E2%80%93Landau_theory) model
the behavior of extreme type-II superconductors under a magnetic field. The
above example (to be found in full detail
[here](tests/test_ginzburg_landau.py)) shows parameter continuation in the
strength of the magnetic field. The plot on the right-hand side shows the
complex-valued solution using [cplot](https://github.com/nschloe/cplot).


### License
Expand Down
4 changes: 2 additions & 2 deletions setup.cfg
@@ -1,6 +1,6 @@
[metadata]
name = pacopy
version = 0.1.8
version = 0.1.9
author = Nico Schlömer
author_email = nico.schloemer@gmail.com
description = Numerical continuation in Python
Expand Down Expand Up @@ -32,8 +32,8 @@ package_dir =
packages = find:
install_requires =
rich
typing_extensions;python_version<"3.8"
python_requires = >=3.7

[options.packages.find]
where=src

0 comments on commit b727121

Please sign in to comment.