From 8f926ad98c9ea14b26091473d327c3949f099ccd Mon Sep 17 00:00:00 2001 From: Thomas Grandits Date: Fri, 22 Oct 2021 10:41:21 +0200 Subject: [PATCH] Bumped the version number to 1.1. Minor modifications to the contribution guidelines. --- CONTRIBUTING.md | 9 ++++----- setup.py | 2 +- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f4acc2..6ede1a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,6 @@ Thank you for your interest in FIM-Python. Any help and contributions are appreciated. - Reporting Bugs --------------------- @@ -37,7 +36,7 @@ except ImportError: Submitting Code -------------------- -FIM-Python uses [pytest](https://docs.pytest.org) to test the code. Pip can take care of installing all necessary packages by listing the extra ``tests``: +FIM-Python uses the [pytest](https://docs.pytest.org) framework. Pip can take care of installing all necessary packages by listing the extra ``tests``: ```bash pip install fim-python[gpu,tests] ``` @@ -47,9 +46,9 @@ python tests/generate_test_data.py #First time only to generate the test example python -m pytest tests ``` -Before opening a pull request, please make sure that all tests are passing. +Before opening a pull request for newly written code, please make sure that all tests are passing. In case you only have the CPU version, all tests for the GPU will be skipped. -The github-runner will also test committed versions of the library, but only on the CPU for the lack of a GPU on the runner. -If you submit new features, please also write tests to ensure functionality of the features. +If you submit new features, please also write tests to ensure functionality of these features. +The github-runner will also test pull-requests and committed versions of the library, but only on the CPU for the lack of a GPU on the runner. > **_Note:_** If you do **not** have a Cupy compatible GPU to test on, please clearly state this in your pull request, so somebody else from the community can test your code with all features enabled. diff --git a/setup.py b/setup.py index 1984346..f05b9cd 100644 --- a/setup.py +++ b/setup.py @@ -28,7 +28,7 @@ long_description = readme.read() setup(name="fim-python", - version="1.0.1", + version="1.1", description="This repository implements the Fast Iterative Method on tetrahedral domains and triangulated surfaces purely in python both for CPU (numpy) and GPU (cupy).", long_description=long_description, long_description_content_type="text/markdown",