cfdpre 0.2.1__tar.gz → 0.2.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: cfdpre
3
- Version: 0.2.1
3
+ Version: 0.2.3
4
4
  Summary: CFD PreProcessing Library
5
5
  Author: Pushkar Sheth
6
6
  Author-email: siglyserdev@gmail.com
@@ -8,11 +8,13 @@ Description-Content-Type: text/markdown
8
8
  Requires-Dist: numpy
9
9
  Requires-Dist: CoolProp
10
10
 
11
- # CFDPre
11
+ <h1 align="center">
12
+ <img src="https://raw.githubusercontent.com/phsheth/cfdpre/refs/heads/main/cfdprelogo.png" width="300">
13
+ </h1><br>
12
14
 
13
15
 
14
16
  What is CFDPre?
15
- ================
17
+ ----------------------
16
18
 
17
19
  CFDPre is an open-source collection of object-oriented software tools for
18
20
  calculating boundary layer mesh dimensions for Computational Fluid Dynamics simulations.
@@ -22,18 +24,21 @@ Among other things, it can be used to:
22
24
 
23
25
 
24
26
  Installation
25
- ============
27
+ ----------------------
26
28
 
27
- [![PyPI Downloads](https://img.shields.io/pypi/v/cfdpre?label=PyPI%20downloads)](
28
- https://pypi.org/project/cfdpre/)
29
+ [![Install](https://img.shields.io/pypi/v/cfdpre?label=CFDPre)](
30
+ https://pypi.org/project/cfdpre/) [![PyPI Downloads](https://img.shields.io/pypi/dm/cfdpre?label=PyPI%20Downloads)](
31
+ https://pypistats.org/packages/cfdpre)
29
32
 
33
+ In your command line, within Python environment:
34
+ ```pythom
30
35
  pip install cfdpre
31
-
36
+ ```
32
37
  - The Python module can also be installed using pip on Windows, macOS, and Linux.
33
38
 
34
39
 
35
40
  Usage
36
- =====
41
+ ----------------------
37
42
 
38
43
  ```python
39
44
  from cfdpre import yhgrcalc
@@ -41,7 +46,7 @@ yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8)
41
46
  ```
42
47
 
43
48
  Output:
44
- ```
49
+ ```python
45
50
  {'fluid': 'Air',
46
51
  'temperature [C]': 50,
47
52
  'pressure [bar]': 10,
@@ -65,35 +70,32 @@ Output:
65
70
  'Final Layer Thickness [m]': 0.0016186648187374525}
66
71
  ```
67
72
 
68
-
69
-
70
73
  Documentation
71
- =============
74
+ ----------------------
72
75
 
73
76
  In progress - not yet made!
74
77
 
75
- Users' Group
76
- ============
77
-
78
+ - **Project Home Page:** https://cfdpre.github.io/ [under construction]
78
79
  - **Users Group:** https://groups.google.com/g/cfdpre
80
+ - **Source code:** https://github.com/phsheth/cfdpre
81
+ - **PyPI Page:** https://pypi.org/project/cfdpre/
79
82
 
80
- Source Code
81
- ===========
82
83
 
83
- - **Source code:** https://github.com/phsheth/cfdpre
84
84
 
85
- Call for Contributions
85
+ Call for Contributors
86
86
  ----------------------
87
87
 
88
- The CFDPre project welcomes your expertise and enthusiasm! Better to discuss before strarting to contribute!
88
+ The CFDPre project welcomes your expertise and enthusiasm! Better to discuss on the users group before starting to contribute!
89
89
 
90
90
 
91
- ## Project Log
91
+ Project Log
92
+ ----------------------
92
93
  January 2025:
93
94
  1. Created Library
94
95
 
95
96
 
96
- ## Project Road Map:
97
+ Project RoadMap:
98
+ ----------------------
97
99
 
98
100
  1. Documentation for existing functionality.
99
101
  2. Include example data within library.
@@ -1,8 +1,10 @@
1
- # CFDPre
1
+ <h1 align="center">
2
+ <img src="https://raw.githubusercontent.com/phsheth/cfdpre/refs/heads/main/cfdprelogo.png" width="300">
3
+ </h1><br>
2
4
 
3
5
 
4
6
  What is CFDPre?
5
- ================
7
+ ----------------------
6
8
 
7
9
  CFDPre is an open-source collection of object-oriented software tools for
8
10
  calculating boundary layer mesh dimensions for Computational Fluid Dynamics simulations.
@@ -12,18 +14,21 @@ Among other things, it can be used to:
12
14
 
13
15
 
14
16
  Installation
15
- ============
17
+ ----------------------
16
18
 
17
- [![PyPI Downloads](https://img.shields.io/pypi/v/cfdpre?label=PyPI%20downloads)](
18
- https://pypi.org/project/cfdpre/)
19
+ [![Install](https://img.shields.io/pypi/v/cfdpre?label=CFDPre)](
20
+ https://pypi.org/project/cfdpre/) [![PyPI Downloads](https://img.shields.io/pypi/dm/cfdpre?label=PyPI%20Downloads)](
21
+ https://pypistats.org/packages/cfdpre)
19
22
 
23
+ In your command line, within Python environment:
24
+ ```pythom
20
25
  pip install cfdpre
21
-
26
+ ```
22
27
  - The Python module can also be installed using pip on Windows, macOS, and Linux.
23
28
 
24
29
 
25
30
  Usage
26
- =====
31
+ ----------------------
27
32
 
28
33
  ```python
29
34
  from cfdpre import yhgrcalc
@@ -31,7 +36,7 @@ yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8)
31
36
  ```
32
37
 
33
38
  Output:
34
- ```
39
+ ```python
35
40
  {'fluid': 'Air',
36
41
  'temperature [C]': 50,
37
42
  'pressure [bar]': 10,
@@ -55,35 +60,32 @@ Output:
55
60
  'Final Layer Thickness [m]': 0.0016186648187374525}
56
61
  ```
57
62
 
58
-
59
-
60
63
  Documentation
61
- =============
64
+ ----------------------
62
65
 
63
66
  In progress - not yet made!
64
67
 
65
- Users' Group
66
- ============
67
-
68
+ - **Project Home Page:** https://cfdpre.github.io/ [under construction]
68
69
  - **Users Group:** https://groups.google.com/g/cfdpre
70
+ - **Source code:** https://github.com/phsheth/cfdpre
71
+ - **PyPI Page:** https://pypi.org/project/cfdpre/
69
72
 
70
- Source Code
71
- ===========
72
73
 
73
- - **Source code:** https://github.com/phsheth/cfdpre
74
74
 
75
- Call for Contributions
75
+ Call for Contributors
76
76
  ----------------------
77
77
 
78
- The CFDPre project welcomes your expertise and enthusiasm! Better to discuss before strarting to contribute!
78
+ The CFDPre project welcomes your expertise and enthusiasm! Better to discuss on the users group before starting to contribute!
79
79
 
80
80
 
81
- ## Project Log
81
+ Project Log
82
+ ----------------------
82
83
  January 2025:
83
84
  1. Created Library
84
85
 
85
86
 
86
- ## Project Road Map:
87
+ Project RoadMap:
88
+ ----------------------
87
89
 
88
90
  1. Documentation for existing functionality.
89
91
  2. Include example data within library.
@@ -98,8 +98,8 @@ def yhgrcalc(fluid, temperature_c, pressure_bar, massflow_kgpersec, hydraulicdia
98
98
  'prandtl number' : prandtl,
99
99
  'skin friction coefficient [cf]' : cf,
100
100
  'wall shear stress [tau_wall]' : tau_wall,
101
- 'yplus [m]' : yp_m,
102
- 'first layer height [m]' : yh_m,
101
+ 'height of cell centroid from wall [yp] [m]' : yp_m,
102
+ 'first layer height [yh] [m]' : yh_m,
103
103
  'Growth Ratio' : growth_ratio,
104
104
  'Final Layer Thickness [m]' : final_layer_thickness_m
105
105
  }
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: cfdpre
3
- Version: 0.2.1
3
+ Version: 0.2.3
4
4
  Summary: CFD PreProcessing Library
5
5
  Author: Pushkar Sheth
6
6
  Author-email: siglyserdev@gmail.com
@@ -8,11 +8,13 @@ Description-Content-Type: text/markdown
8
8
  Requires-Dist: numpy
9
9
  Requires-Dist: CoolProp
10
10
 
11
- # CFDPre
11
+ <h1 align="center">
12
+ <img src="https://raw.githubusercontent.com/phsheth/cfdpre/refs/heads/main/cfdprelogo.png" width="300">
13
+ </h1><br>
12
14
 
13
15
 
14
16
  What is CFDPre?
15
- ================
17
+ ----------------------
16
18
 
17
19
  CFDPre is an open-source collection of object-oriented software tools for
18
20
  calculating boundary layer mesh dimensions for Computational Fluid Dynamics simulations.
@@ -22,18 +24,21 @@ Among other things, it can be used to:
22
24
 
23
25
 
24
26
  Installation
25
- ============
27
+ ----------------------
26
28
 
27
- [![PyPI Downloads](https://img.shields.io/pypi/v/cfdpre?label=PyPI%20downloads)](
28
- https://pypi.org/project/cfdpre/)
29
+ [![Install](https://img.shields.io/pypi/v/cfdpre?label=CFDPre)](
30
+ https://pypi.org/project/cfdpre/) [![PyPI Downloads](https://img.shields.io/pypi/dm/cfdpre?label=PyPI%20Downloads)](
31
+ https://pypistats.org/packages/cfdpre)
29
32
 
33
+ In your command line, within Python environment:
34
+ ```pythom
30
35
  pip install cfdpre
31
-
36
+ ```
32
37
  - The Python module can also be installed using pip on Windows, macOS, and Linux.
33
38
 
34
39
 
35
40
  Usage
36
- =====
41
+ ----------------------
37
42
 
38
43
  ```python
39
44
  from cfdpre import yhgrcalc
@@ -41,7 +46,7 @@ yhgrcalc('Air', 50, 10, 2.5, 125, 1, 8)
41
46
  ```
42
47
 
43
48
  Output:
44
- ```
49
+ ```python
45
50
  {'fluid': 'Air',
46
51
  'temperature [C]': 50,
47
52
  'pressure [bar]': 10,
@@ -65,35 +70,32 @@ Output:
65
70
  'Final Layer Thickness [m]': 0.0016186648187374525}
66
71
  ```
67
72
 
68
-
69
-
70
73
  Documentation
71
- =============
74
+ ----------------------
72
75
 
73
76
  In progress - not yet made!
74
77
 
75
- Users' Group
76
- ============
77
-
78
+ - **Project Home Page:** https://cfdpre.github.io/ [under construction]
78
79
  - **Users Group:** https://groups.google.com/g/cfdpre
80
+ - **Source code:** https://github.com/phsheth/cfdpre
81
+ - **PyPI Page:** https://pypi.org/project/cfdpre/
79
82
 
80
- Source Code
81
- ===========
82
83
 
83
- - **Source code:** https://github.com/phsheth/cfdpre
84
84
 
85
- Call for Contributions
85
+ Call for Contributors
86
86
  ----------------------
87
87
 
88
- The CFDPre project welcomes your expertise and enthusiasm! Better to discuss before strarting to contribute!
88
+ The CFDPre project welcomes your expertise and enthusiasm! Better to discuss on the users group before starting to contribute!
89
89
 
90
90
 
91
- ## Project Log
91
+ Project Log
92
+ ----------------------
92
93
  January 2025:
93
94
  1. Created Library
94
95
 
95
96
 
96
- ## Project Road Map:
97
+ Project RoadMap:
98
+ ----------------------
97
99
 
98
100
  1. Documentation for existing functionality.
99
101
  2. Include example data within library.
@@ -8,7 +8,7 @@ with open("README.md", "r") as f:
8
8
 
9
9
  setup(
10
10
  name='cfdpre',
11
- version='0.2.1',
11
+ version='0.2.3',
12
12
  description='CFD PreProcessing Library',
13
13
  author='Pushkar Sheth',
14
14
  author_email='siglyserdev@gmail.com',
File without changes
File without changes