From c3da32419627a0b1bd2b33d12aeb1f7e04212e47 Mon Sep 17 00:00:00 2001
From: Martin Bauer <martin.bauer@fau.de>
Date: Mon, 29 Apr 2019 10:26:10 +0200
Subject: [PATCH] Load README in setup.py to appear on PyPI
- updates in readme text
- added release script
---
README.md | 8 +++++---
release.sh | 13 +++++++++++++
setup.py | 8 +++++++-
3 files changed, 25 insertions(+), 4 deletions(-)
create mode 100644 release.sh
diff --git a/README.md b/README.md
index e864251cd..a099505bb 100644
--- a/README.md
+++ b/README.md
@@ -7,8 +7,10 @@ pystencils
Run blazingly fast stencil codes on numpy arrays.
-*pystencils* uses sympy to define stencil operations, that can be executed on numpy array.
-It runs faster than normal numpy code and even as Cython and numba.
+*pystencils* uses sympy to define stencil operations, that can be executed on numpy arrays.
+Exploiting the stencil structure makes *pystencils* run faster than normal numpy code and even as Cython and numba,
+[as demonstrated in this notebook](http://pycodegen.pages.walberla.net/pystencils/notebooks/demo_benchmark.html).
+
Here is a code snippet that computes the average of neighboring cells:
```python
@@ -48,7 +50,7 @@ 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
+- `gpu`: use this if an 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.
diff --git a/release.sh b/release.sh
new file mode 100644
index 000000000..43ef605f8
--- /dev/null
+++ b/release.sh
@@ -0,0 +1,13 @@
+#!/bin/bash
+
+echo "Existing versions"
+git tag -l | grep release
+
+echo "Enter the next version"
+read new_version
+
+git tag -s release/${new_version}
+git push origin master release/${new_version}
+python setup.py sdist bdist_wheel
+rm -rf dist
+twine upload dist/*
\ No newline at end of file
diff --git a/setup.py b/setup.py
index a24dafccb..3110d16f1 100644
--- a/setup.py
+++ b/setup.py
@@ -47,10 +47,16 @@ class SimpleTestRunner(distutils.cmd.Command):
for test in quick_tests:
self._run_tests_in_module(test)
+def readme():
+ with open('README.md') as f:
+ return f.read()
+
setup(name='pystencils',
version=version_number_from_git(),
- description='Python Stencil Compiler based on sympy as numpy',
+ description='Speeding up stencil computations on CPUs and GPUs',
+ long_description=readme(),
+ long_description_content_type="text/markdown",
author='Martin Bauer',
license='AGPLv3',
author_email='martin.bauer@fau.de',
--
GitLab