ansys-turbogrid-core 0.3.dev0__tar.gz → 0.4.dev1__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: ansys-turbogrid-core
3
- Version: 0.3.dev0
3
+ Version: 0.4.dev1
4
4
  Summary: A python wrapper for Ansys TurboGrid
5
5
  Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
6
6
  Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
@@ -16,26 +16,28 @@ Classifier: Programming Language :: Python :: 3.8
16
16
  Classifier: Programming Language :: Python :: 3.9
17
17
  Classifier: Programming Language :: Python :: 3.10
18
18
  Classifier: Programming Language :: Python :: 3.11
19
- Requires-Dist: ansys-turbogrid-api>=0.3.dev0
19
+ Requires-Dist: ansys-turbogrid-api>=0.4.dev1
20
20
  Requires-Dist: matplotlib>=3.5.1
21
21
  Requires-Dist: importlib-metadata>=4.0
22
- Requires-Dist: ansys-sphinx-theme==0.9.9 ; extra == "doc"
22
+ Requires-Dist: fabric>=3.2.2
23
+ Requires-Dist: Jinja2>=3.1.2
24
+ Requires-Dist: ansys-sphinx-theme==0.13.0 ; extra == "doc"
23
25
  Requires-Dist: autodocsumm==0.2.11 ; extra == "doc"
24
26
  Requires-Dist: ipyvtklink==0.2.3 ; extra == "doc"
25
27
  Requires-Dist: jupyter_sphinx==0.4.0 ; extra == "doc"
26
28
  Requires-Dist: jupytext==1.14.6 ; extra == "doc"
27
- Requires-Dist: nbconvert==7.6.0 ; extra == "doc"
29
+ Requires-Dist: nbconvert==7.14.1 ; extra == "doc"
28
30
  Requires-Dist: nbsphinx==0.9.2 ; extra == "doc"
29
31
  Requires-Dist: notebook==6.5.4 ; extra == "doc"
30
32
  Requires-Dist: numpydoc==1.5.0 ; extra == "doc"
31
- Requires-Dist: panel==1.1.1 ; extra == "doc"
32
- Requires-Dist: Sphinx==7.0.1 ; extra == "doc"
33
- Requires-Dist: sphinx-autoapi==2.1.1 ; extra == "doc"
34
- Requires-Dist: sphinx-autodoc-typehints==1.23.2 ; extra == "doc"
33
+ Requires-Dist: panel==1.3.6 ; extra == "doc"
34
+ Requires-Dist: Sphinx==7.2.6 ; extra == "doc"
35
+ Requires-Dist: sphinx-autoapi==3.0.0 ; extra == "doc"
36
+ Requires-Dist: sphinx-autodoc-typehints==1.25.2 ; extra == "doc"
35
37
  Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
36
38
  Requires-Dist: sphinx-gallery==0.13.0 ; extra == "doc"
37
39
  Requires-Dist: matplotlib>=3.5.1 ; extra == "tests"
38
- Requires-Dist: pytest==7.2.2 ; extra == "tests"
40
+ Requires-Dist: pytest==7.4.4 ; extra == "tests"
39
41
  Requires-Dist: pytest-cov==4.1.0 ; extra == "tests"
40
42
  Project-URL: Documentation, https://turbogrid.docs.pyansys.com/version/stable/
41
43
  Project-URL: Homepage, https://turbogrid.docs.pyansys.com
@@ -52,12 +54,12 @@ PyTurboGrid
52
54
  :target: https://docs.pyansys.com/
53
55
  :alt: PyAnsys
54
56
 
55
- .. |python| image:: https://img.shields.io/pypi/pyversions/pyturbogrid?logo=pypi
56
- :target: https://pypi.org/project/pyturbogrid/
57
+ .. |python| image:: https://img.shields.io/pypi/pyversions/ansys-turbogrid-core?logo=pypi
58
+ :target: https://pypi.org/project/ansys-turbogrid-core/
57
59
  :alt: Python
58
60
 
59
- .. |pypi| image:: https://img.shields.io/pypi/v/pyturbogrid.svg?logo=python&logoColor=white
60
- :target: https://pypi.org/project/pyturbogrid
61
+ .. |pypi| image:: https://img.shields.io/pypi/v/ansys-turbogrid-core.svg?logo=python&logoColor=white
62
+ :target: https://pypi.org/project/ansys-turbogrid-core
61
63
  :alt: PyPI
62
64
 
63
65
  .. |codecov| image:: https://codecov.io/gh/ansys/pyturbogrid/branch/main/graph/badge.svg
@@ -91,7 +93,7 @@ of TurboGrid. PyTurboGrid supports Ansys TurboGrid 2023 R2 and later.
91
93
 
92
94
  Installation
93
95
  ------------
94
- The ``ansys-turbogrid-core`` package supports Python 3.10 on Windows and Linux. Two modes
96
+ The ``ansys-turbogrid-core`` package supports Python 3.8, 3.9, 3.10 and 3.11 on Windows and Linux. Two modes
95
97
  of installation are available:
96
98
 
97
99
  - User installation
@@ -123,7 +125,7 @@ source code, you can modify and enhance the code.
123
125
  Overall guidance on contributing to a PyAnsys library appears in the
124
126
  `Contributing <https://dev.docs.pyansys.com/how-to/contributing.html>`_ topic
125
127
  in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
126
- with this `guide <https://dev.docs.pyansys.com/>_` before attempting to
128
+ with this `guide <https://dev.docs.pyansys.com/>`_ before attempting to
127
129
  contribute to PyTurboGrid.
128
130
 
129
131
  #. Clone the ``pyturbogrid`` repository:
@@ -6,12 +6,12 @@ PyTurboGrid
6
6
  :target: https://docs.pyansys.com/
7
7
  :alt: PyAnsys
8
8
 
9
- .. |python| image:: https://img.shields.io/pypi/pyversions/pyturbogrid?logo=pypi
10
- :target: https://pypi.org/project/pyturbogrid/
9
+ .. |python| image:: https://img.shields.io/pypi/pyversions/ansys-turbogrid-core?logo=pypi
10
+ :target: https://pypi.org/project/ansys-turbogrid-core/
11
11
  :alt: Python
12
12
 
13
- .. |pypi| image:: https://img.shields.io/pypi/v/pyturbogrid.svg?logo=python&logoColor=white
14
- :target: https://pypi.org/project/pyturbogrid
13
+ .. |pypi| image:: https://img.shields.io/pypi/v/ansys-turbogrid-core.svg?logo=python&logoColor=white
14
+ :target: https://pypi.org/project/ansys-turbogrid-core
15
15
  :alt: PyPI
16
16
 
17
17
  .. |codecov| image:: https://codecov.io/gh/ansys/pyturbogrid/branch/main/graph/badge.svg
@@ -45,7 +45,7 @@ of TurboGrid. PyTurboGrid supports Ansys TurboGrid 2023 R2 and later.
45
45
 
46
46
  Installation
47
47
  ------------
48
- The ``ansys-turbogrid-core`` package supports Python 3.10 on Windows and Linux. Two modes
48
+ The ``ansys-turbogrid-core`` package supports Python 3.8, 3.9, 3.10 and 3.11 on Windows and Linux. Two modes
49
49
  of installation are available:
50
50
 
51
51
  - User installation
@@ -77,7 +77,7 @@ source code, you can modify and enhance the code.
77
77
  Overall guidance on contributing to a PyAnsys library appears in the
78
78
  `Contributing <https://dev.docs.pyansys.com/how-to/contributing.html>`_ topic
79
79
  in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
80
- with this `guide <https://dev.docs.pyansys.com/>_` before attempting to
80
+ with this `guide <https://dev.docs.pyansys.com/>`_ before attempting to
81
81
  contribute to PyTurboGrid.
82
82
 
83
83
  #. Clone the ``pyturbogrid`` repository:
@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
5
5
  [project]
6
6
  # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
7
7
  name = "ansys-turbogrid-core"
8
- version = "0.3.dev0"
8
+ version = "0.4.dev1"
9
9
  description = "A python wrapper for Ansys TurboGrid"
10
10
  readme = "README.rst"
11
11
  requires-python = ">=3.8,<4"
@@ -32,31 +32,33 @@ classifiers = [
32
32
  ]
33
33
 
34
34
  dependencies = [
35
- "ansys-turbogrid-api>=0.3.dev0",
35
+ "ansys-turbogrid-api>=0.4.dev1",
36
36
  "matplotlib>=3.5.1",
37
37
  "importlib-metadata>=4.0",
38
+ "fabric>=3.2.2",
39
+ "Jinja2>=3.1.2",
38
40
  ]
39
41
 
40
42
  [project.optional-dependencies]
41
43
  tests = [
42
44
  "matplotlib>=3.5.1",
43
- "pytest==7.2.2",
45
+ "pytest==7.4.4",
44
46
  "pytest-cov==4.1.0",
45
47
  ]
46
48
  doc = [
47
- "ansys-sphinx-theme==0.9.9",
49
+ "ansys-sphinx-theme==0.13.0",
48
50
  "autodocsumm==0.2.11",
49
51
  "ipyvtklink==0.2.3",
50
52
  "jupyter_sphinx==0.4.0",
51
53
  "jupytext==1.14.6",
52
- "nbconvert==7.6.0",
54
+ "nbconvert==7.14.1",
53
55
  "nbsphinx==0.9.2",
54
56
  "notebook==6.5.4",
55
57
  "numpydoc==1.5.0",
56
- "panel==1.1.1",
57
- "Sphinx==7.0.1",
58
- "sphinx-autoapi==2.1.1",
59
- "sphinx-autodoc-typehints==1.23.2",
58
+ "panel==1.3.6",
59
+ "Sphinx==7.2.6",
60
+ "sphinx-autoapi==3.0.0",
61
+ "sphinx-autodoc-typehints==1.25.2",
60
62
  "sphinx-copybutton==0.5.2",
61
63
  "sphinx-gallery==0.13.0",
62
64
  ]
@@ -80,17 +82,6 @@ line_length = 120
80
82
  default_section = "THIRDPARTY"
81
83
  src_paths = ["doc", "src", "tests"]
82
84
 
83
- [[tool.poetry.source]]
84
- name = "privatepypi"
85
- url = "https://pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/"
86
- default = false
87
- secondary = true
88
-
89
- [tool.poetry.dependencies]
90
- python = ">=3.7,<4.0"
91
- ansys-turbogrid-api = {source = "privatepypi"}
92
-
93
-
94
85
  [tool.coverage.run]
95
86
  source = ["ansys.turbogrid.core"]
96
87
 
@@ -19,6 +19,7 @@ class TurboGridVersion(Enum):
19
19
  """Provide an enumeration over supported TurboGrid versions."""
20
20
 
21
21
  # Versions must be listed here with the most recent first
22
+ version_24R1 = "24.1.0"
22
23
  version_23R2 = "23.2.0"
23
24
 
24
25
  @classmethod
@@ -120,6 +121,8 @@ def launch_turbogrid(
120
121
  additional_args_str: str = None,
121
122
  additional_kw_args: dict = None,
122
123
  port: Optional[int] = None,
124
+ host: str = "127.0.0.1",
125
+ log_filename_suffix: str = "",
123
126
  **kwargs,
124
127
  ) -> pyturbogrid_core.PyTurboGrid:
125
128
  """Launch TurboGrid locally in server mode.
@@ -136,7 +139,7 @@ def launch_turbogrid(
136
139
  log_level : pyturbogrid_core.PyTurboGrid.TurboGridLogLevel, default: ``INFO``
137
140
  Level of logging information written to the terminal. The default is ``INFO``.
138
141
  Options are ``INFO``, ``WARNING``, ``ERROR``, ``CRITICAL``, and ``DEBUG``.
139
- This setting does not affect the level of output that is written to the log files.
142
+ This setting also affects the level of output that is written to the log files.
140
143
  additional_args_str : str, default: ``None``
141
144
  Additional arguments to send to TurboGrid.
142
145
  additional_kw_args : dict, default: ``None``
@@ -144,6 +147,10 @@ def launch_turbogrid(
144
147
  port : int, default: ``None``
145
148
  Port for TurboGrid communications. The default is ``None``, in which case
146
149
  an available port is automatically selected.
150
+ host : str, default: ``127.0.0.1 (this is the local host IP for windows and linux)``
151
+ Host for TurboGrid communications. The default is ``127.0.0.1, or the local host``
152
+ log_filename_suffix : str, default: ""
153
+ Suffix for name of the log files written out.
147
154
 
148
155
  Returns
149
156
  -------
@@ -162,7 +169,42 @@ def launch_turbogrid(
162
169
  socket_port=port,
163
170
  turbogrid_location_type=pyturbogrid_core.PyTurboGrid.TurboGridLocationType.TURBOGRID_INSTALL,
164
171
  cfxtg_location=pathToCFXTG,
165
- log_level=log_level,
166
172
  additional_args_str=additional_args_str,
167
173
  additional_kw_args=additional_kw_args,
174
+ log_level=log_level,
175
+ host_ip=host,
176
+ log_filename_suffix=log_filename_suffix,
177
+ )
178
+
179
+
180
+ def launch_turbogrid_ansys_labs(
181
+ product_version: str = "latest",
182
+ log_level: pyturbogrid_core.PyTurboGrid.TurboGridLogLevel = pyturbogrid_core.PyTurboGrid.TurboGridLogLevel.INFO,
183
+ ) -> pyturbogrid_core.PyTurboGrid:
184
+ """Launch TurboGrid from within the Ansys Labs environment.
185
+
186
+ Parameters
187
+ ----------
188
+ product_version : str, default: ``latest``
189
+ Version of TurboGrid to launch in the Ansys Labs environment. Only certain versions are supported.
190
+ log_level : pyturbogrid_core.PyTurboGrid.TurboGridLogLevel, default: ``INFO``
191
+ Level of logging information written to the terminal. The default is ``INFO``.
192
+ Options are ``INFO``, ``WARNING``, ``ERROR``, ``CRITICAL``, and ``DEBUG``.
193
+ This setting also affects the level of output that is written to the log files.
194
+
195
+ Returns
196
+ -------
197
+ pyturbogrid_core.PyTurboGrid
198
+ TurboGrid session.
199
+ """
200
+ return pyturbogrid_core.PyTurboGrid(
201
+ socket_port=0,
202
+ turbogrid_location_type=pyturbogrid_core.PyTurboGrid.TurboGridLocationType.TURBOGRID_ANSYS_LABS,
203
+ cfxtg_location="",
204
+ additional_args_str=None,
205
+ additional_kw_args=None,
206
+ log_level=log_level,
207
+ host_ip="",
208
+ pim_app_name="turbogrid",
209
+ pim_app_ver=product_version,
168
210
  )