Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc/add workflows #88

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Doc/add workflows #88

wants to merge 10 commits into from

Conversation

margalva
Copy link
Collaborator

@margalva margalva commented Jan 5, 2024

Add cheat sheet at the home page of the docs
Add a section for the workflow examples, and add the Fluent -> Ensight -> ADR example.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3134fd3) 75.94% compared to head (7332424) 75.94%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #88   +/-   ##
=======================================
  Coverage   75.94%   75.94%           
=======================================
  Files          16       16           
  Lines        5002     5002           
  Branches     1052     1052           
=======================================
  Hits         3799     3799           
  Misses        854      854           
  Partials      349      349           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


import ansys.dynamicreporting.core as adr

os.environ["AWP_ROOT241"] = r"""C:\Program Files\ANSYS Inc\v241"""
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a fan of these kinds of things being exposed in these scripts. Please let the script assume that a version of the Ansys installation can be found without this type of guidance.

os.environ["AWP_ROOT241"] = r"""C:\Program Files\ANSYS Inc\v241"""

ansys_loc = r"""C:\Program Files\ANSYS Inc\v241"""
db_dir = r"""C:\fluent_workflow\db_dir"""
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use a Python tempdir for this or something similar? As written, it certainly has issues on Linux and probably most Windows machines :).

# https://github.com/ansys/pydynamicreporting/tree/main/doc/source/_data.
#

ctx_file = r"""C:\fluent_workflow\context1a.ctx"""
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hardcoded pathname that would be easy to miss if you were trying to run this.

ensession.ensight.part.select_all()
ensession.ensight.savegeom.format("avz")
ensession.ensight.savegeom.select_all_steps()
ensession.ensight.savegeom.save_geometric_entities(r"""C:\fluent_workflow\export_avz""")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess in general, using a temporary directory would be better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants