ansys / pyfluent

Pythonic interface to Ansys Fluent
https://fluent.docs.pyansys.com
MIT License
262 stars 41 forks source link

Lightweight_setup invalid on read_<type> commands #2273

Closed millerj97 closed 4 months ago

millerj97 commented 10 months ago

πŸ” Before submitting the issue

🐞 Description of the bug

The keyword lightweight_setup=True is only valid for the solver.file.read() command, using in other commands such as solver.file.read_case(lightweight_setup=True) results in;

raise RuntimeError("Argument '" + str(k) + "' is invalid")
RuntimeError: Argument 'lightweight_setup' is invalid

Documentation shows keyword being valid in all read options; image

πŸ“ Steps to reproduce

Successful commands;

import ansys.fluent.core as pyfluent
from ansys.fluent.core import examples
import_file_name = examples.download_file("mixing_elbow.msh.h5", "pyfluent/mixing_elbow")
session = pyfluent.launch_fluent(precision="double", processor_count=2, lightweight_mode=True)
session.file.read(file_name="mixing_elbow.msh.h5", file_type="case", lightweight_setup=True)

error command;

session.file.read_case(file_name="mixing_elbow.msh.h5", lightweight_setup=True)

Repeat with read_mesh(), read_case_data()etc and read(file_type=<type>)

πŸ’» Which operating system are you using?

Windows

πŸ“€ Which ANSYS version are you using?

v242

🐍 Which Python version are you using?

3.10

πŸ“¦ Installed packages

absl-py==2.0.0
ansi2html==1.8.0
ansys-api-fluent==0.3.19
ansys-api-platform-instancemanagement==1.0.0
-e git+https://github.com/pyansys/pyfluent.git@9a287de484225260627fc61e281f29e9bfb905c0#egg=ansys_fluent_core
-e git+https://github.com/ansys/pyfluent-visualization.git@b907538e399406d96da587a38d8518697746593d#egg=ansys_fluent_visualization
ansys-platform-instancemanagement==1.1.2
asttokens==2.4.1
astunparse==1.6.3
bcrypt==4.0.1
beartype==0.16.4
black==23.11.0
blinker==1.7.0
cachetools==5.3.2
certifi==2023.11.17
cffi==1.16.0
cfgv==3.4.0
charset-normalizer==3.3.2
click==8.1.7
colorama==0.4.6
contourpy==1.2.0
coverage==7.3.2
cryptography==41.0.5
cycler==0.12.1
dash==2.14.1
dash-bootstrap-components==1.5.0
dash-core-components==2.0.0
dash-html-components==2.0.0
dash-table==5.0.0
decorator==5.1.1
distlib==0.3.7
docker==6.1.3
et-xmlfile==1.1.0
exceptiongroup==1.2.0
executing==2.0.1
filelock==3.13.1
Flask==3.0.0
flatbuffers==23.5.26
fonttools==4.45.0
gast==0.5.4
google-auth==2.23.4
google-auth-oauthlib==1.1.0
google-pasta==0.2.0
grpcio==1.59.3
grpcio-health-checking==1.48.2
h5py==3.10.0
identify==2.5.32
idna==3.4
imageio==2.33.0
importlib-metadata==6.8.0
iniconfig==2.0.0
ipython==8.17.2
itsdangerous==2.1.2
jedi==0.19.1
Jinja2==3.1.2
joblib==1.3.2
kaleido==0.2.1
keras==2.15.0
kiwisolver==1.4.5
libclang==16.0.6
lxml==4.9.3
Markdown==3.5.1
MarkupSafe==2.1.3
matplotlib==3.8.2
matplotlib-inline==0.1.6
ml-dtypes==0.2.0
mypy-extensions==1.0.0
nest-asyncio==1.5.8
nodeenv==1.8.0
numpy==1.26.2
oauthlib==3.2.2
openpyxl==3.1.2
opt-einsum==3.3.0
packaging==23.2
pandas==2.1.3
paramiko==3.3.1
paramiko-expect==0.3.5
parso==0.8.3
pathspec==0.11.2
Pillow==10.1.0
platformdirs==4.0.0
plotly==5.18.0
pluggy==1.3.0
pooch==1.8.0
pre-commit==3.5.0
prompt-toolkit==3.0.41
protobuf==3.20.3
psutil==5.9.6
pure-eval==0.2.2
pyasn1==0.5.1
pyasn1-modules==0.3.0
pycparser==2.21
Pygments==2.17.2
PyNaCl==1.5.0
pyparsing==3.1.1
PySide6==6.6.0
PySide6-Addons==6.6.0
PySide6-Essentials==6.6.0
pytest==7.4.3
pytest-cov==4.1.0
python-dateutil==2.8.2
python-pptx==0.6.23
pytz==2023.3.post1
pyvista==0.42.3
pyvistaqt==0.11.0
pywin32==306
PyYAML==6.0.1
QtPy==2.4.1
requests==2.31.0
requests-oauthlib==1.3.1
retrying==1.3.4
rsa==4.9
scikit-learn==1.3.2
scipy==1.11.4
scooby==0.9.2
seaborn==0.13.0
shiboken6==6.6.0
six==1.16.0
stack-data==0.6.3
tenacity==8.2.3
tensorboard==2.15.1
tensorboard-data-server==0.7.2
tensorflow==2.15.0
tensorflow-estimator==2.15.0
tensorflow-intel==2.15.0
tensorflow-io-gcs-filesystem==0.31.0
termcolor==2.3.0
threadpoolctl==3.2.0
tomli==2.0.1
traitlets==5.13.0
typing_extensions==4.8.0
tzdata==2023.3
urllib3==2.1.0
virtualenv==20.24.7
vtk==9.3.20230807rc0
wcwidth==0.2.12
websocket-client==1.6.4
Werkzeug==3.0.1
wrapt==1.14.1
xgboost==2.0.2
XlsxWriter==3.1.9
zipp==3.17.0
seanpearsonuk commented 4 months ago

The current documentation is aligned with the API, both showing the argument to be available on in the case of the read() method.