Cavitation Model Example And Example Warning Fix #2102
Conversation
ansaboutin
requested review from
mkundu1,
seanpearsonuk,
ajain-work,
dnwillia-work,
prmukherj,
hpohekar,
h-krishnan and
raph-luc
as code owners
for more information, see https://pre-commit.ci
|
Hi @ansaboutin Re the question about replacing TUI commands with settings API commands, please see this merged PR by @mkundu1 : #2045, which automates the discovery of such translations: "advice will be printed if an equivalent settings API exists". |
There was a problem hiding this comment.
There are too many code comments (compare this with other examples in the repo):
Screenshot example
I would suggest transforming almost all of the code comments into text (everywhere in this example, not only the screenshot above), and moving them to appropriate headings (or alternating between code and text as you see fit). I mentioned a few instances below.
See this for more details on how to switch between text and code: https://sphinx-gallery.github.io/stable/tutorials/plot_parse.html (download python source code at the bottom)
There was a problem hiding this comment.
If the description for each section is going to be in a single block of text, then the text needs to be revised to be more readable (I suggested a few changes as examples). Breaking the longest text blocks into paragraphs may help as well.
In addition, if you think it would be more readable, feel free to consider breaking the larger code blocks into smaller parts, and spreading the text in between code blocks. For reference, see the link I sent above with information on how to more easily switch between text and code blocks.
Co-authored-by: Raphael Luciano <[email protected]>
Co-authored-by: Raphael Luciano <[email protected]>
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Looks much better, thanks @ansaboutin, some additional suggestions below
As in my last suggestion, I think outputting the images to files, that are being shown in the example, is a good idea.
Co-authored-by: Raphael Luciano <[email protected]>
Co-authored-by: Raphael Luciano <[email protected]>
Co-authored-by: Raphael Luciano <[email protected]>
Co-authored-by: Raphael Luciano <[email protected]>
* New example. * Upto line 152. * Forgot .py extension * Solution complete. * commands completed. * Text updated. * Pictures added. * Set the vaporization pressure to comment. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Removed show_gui. * Moved sphinx into code block. * Removed momentum from the object train. * Residuals changed to tui. * cwd removed. * cwd removed from compressible flow. * Removed pd.concat(). * Removed local requirements. * Image adjustments. * Pa changes to kPa. * Thumbnail updates. * Concat dataframe if it is not empty. * Code comments removed. * Update examples/00-fluent/modeling_cavitation.py Co-authored-by: Raphael Luciano <[email protected]> * Update examples/00-fluent/modeling_cavitation.py Co-authored-by: Raphael Luciano <[email protected]> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Adjusted for easier reading. * Removed save_path. * cav.msh -> cav_file * Update examples/00-fluent/modeling_cavitation.py Co-authored-by: Raphael Luciano <[email protected]> * Update examples/00-fluent/modeling_cavitation.py Co-authored-by: Raphael Luciano <[email protected]> * Update examples/00-fluent/modeling_cavitation.py Co-authored-by: Raphael Luciano <[email protected]> * Update examples/00-fluent/modeling_cavitation.py Co-authored-by: Raphael Luciano <[email protected]> * Some additional suggestions below. * Read mesh to text not comment. * Changed to sentence case. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Raphael Luciano <[email protected]>
* Fix vale warnings (#2139) * fix tensor type for displacement variable (#2145) * Fix set_state implementation for command argument instance. (#2147) * Update flobject.py (#2148) * SVAR Doc (#1635) * Test to catch Watchdog launch errors, and improved Watchdog behavior on Windows (#2144) * Cavitation Model Example And Example Warning Fix (#2102) * Add type annotations for some modules under services (#2108) * More robust Windows launch command for Watchdog (#2167) * Making h5py an optional dependency, not installed by default (#2171) * Expose settings root like in pyconsole. (#2149) * Remove timeout loop in FluentConnection (#2126) * Fix SVAR doc (#2172) --------- Co-authored-by: Mainak Kundu <[email protected]> Co-authored-by: Oleg Chernukhin <[email protected]> Co-authored-by: Prithwish Mukherjee <[email protected]> Co-authored-by: Harshal Pohekar <[email protected]> Co-authored-by: Aseem Jain <[email protected]> Co-authored-by: Prithwish Mukherjee <[email protected]> Co-authored-by: Adam Boutin <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Created a new PyFluent example following the Chapter 22: Modeling Cavitation Fluent example.
A few tui commands remain. Equivalent settings commands do not exist.