Unclear how to use ReadCase
- Dominant language
- Python
- Stars
- 497
- Forks
- 77
- Avg merge
- 22h 37m
- Merged PRs (30d)
- 45
Description
### 🔍 Before submitting the issue
- [x] I have searched among the existing issues
- [x] I am using a Python virtual environment
### 🐞 Description of the bug
I was trying to learn how to use ReadCase(solver).
**readcase = ReadCase(solver)**
I tried hovering over readcase but no help popped up. So I ran:
**help(readcase)**
That printed:
Parameters
------------
file_name_1 : str
But if I use autosuggestion by going
readcase.
I see that I need to use **readcase.argument_names** to print the argument names and then pass them to readcase. This is not intuitive.
### 📝 Steps to reproduce
from ansys.fluent.core.solver import ReadCase
readcase = ReadCase(solver)
help(readcase)
### 💻 Which operating system are you using?
Windows
### 📀 Which ANSYS version are you using?
26R1
### 🐍 Which Python version are you using?
3.9
### 📦 Installed packages
```shell
ansys-api-fluent==0.3.36
ansys-api-platform-instancemanagement==1.1.3
ansys-api-tools-filetransfer==0.1.2
ansys-fluent-core==0.37.1
ansys-platform-instancemanagement==1.1.2
ansys-tools-common==0.4.0
ansys-tools-filetransfer==0.2.1
ansys-units==0.9.1
appdirs==1.4.4
asttokens==3.0.1
certifi==2025.11.12
charset-normalizer==3.4.4
click==8.3.1
colorama==0.4.6
comm==0.2.3
debugpy==1.8.19
decorator==5.2.1
defusedxml==0.7.1
Deprecated==1.3.1
docker==7.1.0
exceptiongroup==1.3.1
executing==2.2.1
googleapis-common-protos==1.72.0
grpcio==1.76.0
grpcio-health-checking==1.62.3
grpcio-status==1.62.3
idna==3.11
importlib_metadata==8.7.1
ipykernel==7.1.0
ipython==8.37.0
jedi==0.19.2
joblib==1.5.3
jupyter_client==8.7.0
jupyter_core==5.9.1
matplotlib-inline==0.2.1
nest-asyncio==1.6.0
nltk==3.9.2
numpy==2.2.6
packaging==25.0
pandas==2.3.3
parso==0.8.5
platformdirs==4.5.1
prompt_toolkit==3.0.52
protobuf==4.25.8
psutil==7.2.1
pure_eval==0.2.3
pyansys-tools-report==0.9.0
Pygments==2.19.2
python-dateutil==2.9.0.post0
pytz==2025.2
pywin32==311
PyYAML==6.0.3
pyzmq==27.1.0
regex==2025.11.3
requests==2.32.5
scooby==0.11.0
six==1.17.0
stack-data==0.6.3
tornado==6.5.4
tqdm==4.67.1
traitlets==5.14.3
typing_extensions==4.15.0
tzdata==2025.3
urllib3==2.6.2
wcwidth==0.2.14
wrapt==2.0.1
zipp==3.23.0
```
Contributor guide
Research direction
Start at the ReadCase entry point in ansys.fluent.core.solver and reproduce the documented help(readcase) and readcase.argument_names behavior from the issue. Trace how ReadCase exposes its parameters and determine what usage information should appear so that the required argument names and invocation are discoverable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100