From 1a92620b2c1831d9d1447ae65cdd3df078be9fba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Kl=C3=B6ckner?= Date: Tue, 21 Aug 2018 23:14:39 -0400 Subject: [PATCH] Add a readme with a link to the benchmarks --- README.rst | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..6ad38100 --- /dev/null +++ b/README.rst @@ -0,0 +1,35 @@ +sumpy: n-body kernels and translation operators +=============================================== + +.. image:: https://gitlab.tiker.net/inducer/sumpy/badges/master/pipeline.svg + :target: https://gitlab.tiker.net/inducer/sumpy/commits/master +.. image:: https://badge.fury.io/py/sumpy.png + :target: http://pypi.python.org/pypi/sumpy + +Sumpy is mainly a 'scaffolding' package for Fast Multipole and quadrature methods. +If you're building one of those and need code generation for the required Multipole +and local expansions, come right on in. Together with boxtree, there is a full, +symbolically kernel-independent FMM implementation here. + +Sumpy relies on + +* `numpy `_ for arrays +* `boxtree `_ for FMM tree building +* `sumpy `_ for expansions and analytical routines +* `loopy `_ for fast array operations +* `pytest `_ for automated testing + +and, indirectly, + +* `PyOpenCL `_ as computational infrastructure + +PyOpenCL is likely the only package you'll have to install +by hand, all the others will be installed automatically. + +Resources: + +* `documentation `_ +* `source code via git `_ + +If you can see inside the UIUC firewall, you may browse +`benchmark results `_. \ No newline at end of file -- GitLab