Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Tom Harke
pystencils
Commits
da24cd10
Commit
da24cd10
authored
Mar 22, 2019
by
Martin Bauer
Browse files
Update readme and wrote separate readme's for packages
parent
06efd624
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
da24cd10
pystencils
==========
Run blazingly fast stencil codes on numpy arrays.

Installation
------------
```
bash
export
PIP_EXTRA_INDEX_URL
=
https://www.walberla.net/pip
pip
install
pystencils[interactive]
```
Without
`[interactive]`
you get a minimal version with very little dependencies.
All options:
-
`gpu`
: use this if nVidia GPU is available and CUDA is installed
-
`alltrafos`
: pulls in additional dependencies for loop simplification e.g. libisl
-
`bench_db`
: functionality to store benchmark result in object databases
-
`interactive`
: installs dependencies to work in Jupyter including image I/O, plotting etc.
-
`doc`
: packages to build documentation
Options can be combined e.g.
```
bash
pip
install
pystencils[interactive,gpu,doc]
```
Documentation
-------------
Read the docs
[
here
](
http://software.pages.walberla.net/pystencils/pystencils
)
\ No newline at end of file
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment