Skip to content

Commit

Permalink
Bumped the version number to 1.1.
Browse files Browse the repository at this point in the history
Minor modifications to the contribution guidelines.
  • Loading branch information
thomgrand committed Oct 22, 2021
1 parent 3036d83 commit 8f926ad
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
Thank you for your interest in FIM-Python. Any help and contributions are appreciated.



Reporting Bugs
---------------------

Expand Down Expand Up @@ -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]
```
Expand All @@ -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.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 8f926ad

Please sign in to comment.