Skip to content

Commit 52e3fcd

Browse files
Merge branch 'master' into master
2 parents 12949d1 + b0b1d8d commit 52e3fcd

24 files changed

+137
-609
lines changed

.gitattributes

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
output_samples/** linguist-vendored
2-
appveyor/** linguist-vendored
32
doc/** linguist-documentation

.github/workflows/build_and_pypi.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ jobs:
77
# You can use PyPy versions in python-version.
88
# For example, pypy-2.7 and pypy-3.8
99
matrix:
10-
python-version: ["3.8", "3.9", "3.10"]
10+
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
1111
outputs:
1212
version_changed: ${{ steps.check_file_changed.outputs.files_changed }}
1313
steps:
14-
- run: pip install -U pip pipenv coverage
14+
- run: pip install -U pip pipenv coverage build
1515
- run: pip install -U numpy scipy matplotlib
1616
- name: Check out repository code
1717
uses: actions/checkout@v4
1818
- run: set -o pipefail
1919
- name: Build and install fluidfoam
2020
run: |
21-
cd ${{ github.workspace }} && python setup.py develop --user
21+
cd ${{ github.workspace }} && python -m build && pip install dist/fluidfoam*.whl --user
2222
- name: Test fluidfoam
2323
run: make tests
2424
- name: Test fluidfoam coverage
@@ -28,7 +28,7 @@ jobs:
2828
with:
2929
token: ${{ secrets.codecov }}
3030
fail_ci_if_error: true
31-
files: ./.coverage/coverage.xml
31+
files: ./coverage.xml
3232
flags: unittests
3333
name: codecov-umbrella
3434
verbose: true
@@ -44,6 +44,7 @@ jobs:
4444
uses: casperdcl/deploy-pypi@v2
4545
with:
4646
password: ${{ secrets.PYPI_TOKEN }}
47-
pip: wheel -w dist/ --no-deps .
47+
build: --sdist --wheel --outdir dist .
48+
# old version : pip: wheel -w dist/ --no-deps .
4849
# only upload if a tag is pushed (otherwise just build & check)
4950
upload: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') }}

.github/workflows/build_and_test.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ jobs:
77
# You can use PyPy versions in python-version.
88
# For example, pypy-2.7 and pypy-3.8
99
matrix:
10-
python-version: ["3.8", "3.9", "3.10"]
10+
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
1111
outputs:
1212
version_changed: ${{ steps.check_file_changed.outputs.files_changed }}
1313
steps:
14-
- run: pip install -U pip pipenv coverage
14+
- run: pip install -U pip pipenv coverage build
1515
- run: pip install -U numpy scipy matplotlib
1616
- name: Check out repository code
1717
uses: actions/checkout@v4
1818
- run: set -o pipefail
1919
- name: Build and install fluidfoam
2020
run: |
21-
cd ${{ github.workspace }} && python setup.py develop --user
21+
cd ${{ github.workspace }} && python -m build && pip install dist/fluidfoam*.whl --user
2222
- name: Test fluidfoam
2323
run: make tests
2424
- name: Test fluidfoam coverage

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
syntax: glob
33
*pyc
44
*~
5-
.tox
65
dist
76
fluidfoam.egg-info
87
.coverage

.readthedocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ formats: all
3030
python:
3131
install:
3232
- requirements: doc/requirements.txt
33-
- method: setuptools
33+
- method: pip
3434
path: .

Dockerfile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ RUN /bin/bash -c "git clone https://github.com/fluiddyn/fluidfoam"
2323
WORKDIR /home/openfoam/fluidfoam
2424
RUN /bin/bash -c "make"
2525
RUN /bin/bash -c "make clean"
26-
RUN /bin/bash -c "python3 setup.py develop"
2726

2827
USER openfoam:openfoam
2928
# Set the default entry point & arguments

Dockerfile-ci

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ RUN /bin/bash -c "git clone https://github.com/fluiddyn/fluidfoam"
2323
WORKDIR /home/openfoam/fluidfoam
2424
RUN /bin/bash -c "make"
2525
RUN /bin/bash -c "make clean"
26-
RUN /bin/bash -c "python3 setup.py develop"
2726

2827
USER openfoam:openfoam
2928
# Set the default entry point & arguments
File renamed without changes.

Makefile

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11

2-
.PHONY: clean clean_all develop build_ext_inplace
2+
.PHONY: clean clean_all develop
33

44
develop:
5-
python setup.py develop
6-
7-
build_ext_inplace:
8-
python setup.py build_ext --inplace
5+
python -m build
6+
pip install dist/fluidfoam*.whl --user
97

108
clean:
11-
rm -rf build
9+
rm -rf dist
1210

1311
tests:
1412
python -m unittest discover
@@ -17,7 +15,6 @@ black:
1715
black -l 82 fluidfoam
1816

1917
tests_coverage:
20-
mkdir -p .coverage
2118
coverage run -p -m unittest discover
2219
coverage combine
2320
coverage report

README.rst renamed to README.md

Lines changed: 23 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,70 @@
1-
========
21
fluidfoam
3-
========
2+
=========
43

5-
|release| |docs| |Github-action| |coverage|
6-
7-
.. |release| image:: https://img.shields.io/pypi/v/fluidfoam.svg
8-
:target: https://pypi.python.org/pypi/fluidfoam/
9-
:alt: Latest version
10-
11-
.. |docs| image:: https://readthedocs.org/projects/fluidfoam/badge/?version=latest
12-
:target: http://fluidfoam.readthedocs.org
13-
:alt: Documentation status
14-
15-
.. |Github-action| image:: https://github.com/fluiddyn/fluidfoam/actions/workflows/build_and_test.yml/badge.svg
16-
:target: https://github.com/fluiddyn/fluidfoam/actions
17-
:alt: CI status
18-
19-
.. |coverage| image:: https://codecov.io/gh/fluiddyn/fluidfoam/branch/master/graph/badge.svg
20-
:target: https://codecov.io/gh/fluiddyn/fluidfoam/branch/master/
21-
:alt: Code coverage
4+
[![release](https://img.shields.io/pypi/v/fluidfoam.svg)](https://pypi.python.org/pypi/fluidfoam/)
5+
[![docs](https://readthedocs.org/projects/fluidfoam/badge/?version=latest)](http://fluidfoam.readthedocs.org)
6+
[![Github-action](https://github.com/fluiddyn/fluidfoam/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/fluiddyn/fluidfoam/actions)
7+
[![coverage](https://codecov.io/gh/fluiddyn/fluidfoam/branch/master/graph/badge.svg)](https://codecov.io/gh/fluiddyn/fluidfoam/branch/master/)
228

239
The fluidfoam package provides Python classes useful to perform some plot with OpenFoam data.
2410

2511
What is this repository for?
2612
----------------------------
2713

2814
* Openfoam Tools
29-
* Version : 0.2.8
30-
* Supported OpenFoam Versions : 2.4.0, 4.1 to 9, v1712plus to v2406plus
15+
* Version : 0.2.9
16+
* Supported OpenFoam Versions : 2.4.0, 4.1 to 9, v1712plus to latest
3117
* Supported Python Versions : >= 3.8
3218

3319
Documentation and Examples
3420
--------------------------
3521

36-
`http://fluidfoam.readthedocs.org
37-
<http://fluidfoam.readthedocs.org>`_
22+
[http://fluidfoam.readthedocs.org](http://fluidfoam.readthedocs.org>)
3823

3924
Deployment instructions
4025
-----------------------
4126

4227
The simplest way to install fluidfoam is by using pip::
4328

44-
pip install fluidfoam --user
29+
`pip install fluidfoam --user`
4530

46-
You can get the source code from `github
47-
<https://github.com/fluiddyn/fluidfoam>`_ or from `the Python Package Index
48-
<https://pypi.python.org/pypi/fluidfoam/>`_.
31+
You can get the source code from [github](https://github.com/fluiddyn/fluidfoam>)
32+
or from [the Python Package Index](https://pypi.python.org/pypi/fluidfoam/).
4933

50-
The development mode is often useful. From the root directory, run::
34+
The development mode is often useful. From the fluidfoam directory, run::
5135

52-
python setup.py develop --user
36+
`python3 -m pip install --editable . --user`
37+
38+
Or if you are using a virtual environment, run::
5339

40+
`python3 -m pip install --editable .`
5441

5542
Committing instructions (in development mode)
5643
---------------------------------------------
5744

58-
A good starting point is to follow this `forking tutorial <https://guides.github.com/activities/forking/>`_.
45+
A good starting point is to follow this [forking tutorial](https://guides.github.com/activities/forking/).
5946

6047
To clone your fork of fluidfoam repository::
6148

62-
git clone https://github.com/your_username/fluidfoam
49+
`git clone https://github.com/your_username/fluidfoam`
6350

6451
To get the status of the repository::
6552

66-
git status
53+
`git status`
6754

6855
In case of new/modified file(s)::
6956

70-
git add new_file
57+
`git add new_file`
7158

7259
To commit a revision on the local repository::
7360

74-
git commit -m "comment on the revision"
61+
`git commit -m "comment on the revision"`
7562

7663
To push the revision on your github fluidfoam repository::
7764

78-
git push
65+
`git push`
7966

80-
To propose your changes into the main fluidfoam project, follow again the `forking tutorial <https://guides.github.com/activities/forking/>`_.
67+
To propose your changes into the main fluidfoam project, follow again the [forking tutorial](https://guides.github.com/activities/forking/).
8168

8269
Example Usage
8370
-------------

0 commit comments

Comments
 (0)