|
1 | | -======== |
2 | 1 | fluidfoam |
3 | | -======== |
| 2 | +========= |
4 | 3 |
|
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 | +[](https://pypi.python.org/pypi/fluidfoam/) |
| 5 | +[](http://fluidfoam.readthedocs.org) |
| 6 | +[](https://github.com/fluiddyn/fluidfoam/actions) |
| 7 | +[](https://codecov.io/gh/fluiddyn/fluidfoam/branch/master/) |
22 | 8 |
|
23 | 9 | The fluidfoam package provides Python classes useful to perform some plot with OpenFoam data. |
24 | 10 |
|
25 | 11 | What is this repository for? |
26 | 12 | ---------------------------- |
27 | 13 |
|
28 | 14 | * 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 |
31 | 17 | * Supported Python Versions : >= 3.8 |
32 | 18 |
|
33 | 19 | Documentation and Examples |
34 | 20 | -------------------------- |
35 | 21 |
|
36 | | -`http://fluidfoam.readthedocs.org |
37 | | -<http://fluidfoam.readthedocs.org>`_ |
| 22 | +[http://fluidfoam.readthedocs.org](http://fluidfoam.readthedocs.org>) |
38 | 23 |
|
39 | 24 | Deployment instructions |
40 | 25 | ----------------------- |
41 | 26 |
|
42 | 27 | The simplest way to install fluidfoam is by using pip:: |
43 | 28 |
|
44 | | - pip install fluidfoam --user |
| 29 | + `pip install fluidfoam --user` |
45 | 30 |
|
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/). |
49 | 33 |
|
50 | | -The development mode is often useful. From the root directory, run:: |
| 34 | +The development mode is often useful. From the fluidfoam directory, run:: |
51 | 35 |
|
52 | | - python setup.py develop --user |
| 36 | + `python3 -m pip install --editable . --user` |
| 37 | + |
| 38 | +Or if you are using a virtual environment, run:: |
53 | 39 |
|
| 40 | + `python3 -m pip install --editable .` |
54 | 41 |
|
55 | 42 | Committing instructions (in development mode) |
56 | 43 | --------------------------------------------- |
57 | 44 |
|
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/). |
59 | 46 |
|
60 | 47 | To clone your fork of fluidfoam repository:: |
61 | 48 |
|
62 | | - git clone https://github.com/your_username/fluidfoam |
| 49 | + `git clone https://github.com/your_username/fluidfoam` |
63 | 50 |
|
64 | 51 | To get the status of the repository:: |
65 | 52 |
|
66 | | - git status |
| 53 | + `git status` |
67 | 54 |
|
68 | 55 | In case of new/modified file(s):: |
69 | 56 |
|
70 | | - git add new_file |
| 57 | + `git add new_file` |
71 | 58 |
|
72 | 59 | To commit a revision on the local repository:: |
73 | 60 |
|
74 | | - git commit -m "comment on the revision" |
| 61 | + `git commit -m "comment on the revision"` |
75 | 62 |
|
76 | 63 | To push the revision on your github fluidfoam repository:: |
77 | 64 |
|
78 | | - git push |
| 65 | + `git push` |
79 | 66 |
|
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/). |
81 | 68 |
|
82 | 69 | Example Usage |
83 | 70 | ------------- |
|
0 commit comments