-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into feat/rpyc-integration
- Loading branch information
Showing
12 changed files
with
277 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| FEAT: Update cheat sheet with quarto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| MAINT: Bump ansys/actions from 6 to 7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| MAINT: Bump matplotlib from 3.9.1 to 3.9.1.post1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| [pre-commit.ci] pre-commit autoupdate |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| MAINT: Cheat sheet |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| * | ||
| !cheat_sheet.qmd | ||
| !.gitignore | ||
| /.quarto/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,214 @@ | ||
| --- | ||
| title: PyMechanical cheat sheet | ||
| format: cheat_sheet-pdf | ||
| version: main | ||
| footer: PyMechanical | ||
| footerlinks: | ||
| - urls: 'https://mechanical.docs.pyansys.com/version/stable/' | ||
| text: Documentation | ||
| - urls: 'https://mechanical.docs.pyansys.com/version/stable/getting_started/index.html' | ||
| text: Getting started | ||
| - urls: 'https://mechanical.docs.pyansys.com/version/stable/examples/index.html' | ||
| text: Examples | ||
| - urls: 'https://mechanical.docs.pyansys.com/version/stable/user_guide_scripting/index.html' | ||
| text: Mechanical scripting | ||
| - urls: 'https://mechanical.docs.pyansys.com/version/stable/api/index.html' | ||
| text: API reference | ||
| - urls: 'https://mechanical.docs.pyansys.com/version/stable/kil/index.html' | ||
| text: Known issues and limitations | ||
| execute: | ||
| # output: false | ||
| eval: false | ||
|
|
||
| latex-clean: true | ||
| jupyter: | ||
| jupytext: | ||
| text_representation: | ||
| extension: .qmd | ||
| format_name: quarto | ||
| format_version: '1.0' | ||
| jupytext_version: 1.16.1 | ||
| kernelspec: | ||
| display_name: Python 3 (ipykernel) | ||
| language: python | ||
| name: python3 | ||
| --- | ||
|
|
||
| # Connect to Mechanical Remote session | ||
|
|
||
| ## Launch and connect to session | ||
| ```{python} | ||
| #| eval: false | ||
| # Launch an instance | ||
| from ansys.mechanical.core import launch_mechanical | ||
| mechanical = launch_mechanical() | ||
| ``` | ||
| ## Launch Mechanical UI | ||
| ```{python} | ||
| #| eval: false | ||
| mechanical = launch_mechanical(batch=False) | ||
| ``` | ||
| ## Launch by version | ||
| Verify the license and version of Mechanical that is used: | ||
| ```{python} | ||
| #| eval: false | ||
| print(mechanical) | ||
| ``` | ||
| Launch a specific version of Mechanical: | ||
| ```{python} | ||
| #| eval: false | ||
| from ansys.mechanical.core import find_mechanical | ||
| wb_exe = find_mechanical(242)[0] | ||
| # 'Ansys Inc\\....\\winx64\\AnsysWBU.exe' | ||
| mechanical = launch_mechanical( | ||
| exec_file=wb_exe, verbose_mechanical=True, | ||
| batch=True | ||
| ) | ||
| print(mechanical) | ||
| ``` | ||
| ## Launch Mechanical using the CLI | ||
| ```{python} | ||
| #| eval: false | ||
| ansys-mechanical -r 242 --port 10000 -g | ||
| ``` | ||
| ## Manually connect to the Mechanical session | ||
| ```{python} | ||
| #| eval: false | ||
| import ansys.mechanical.core as pymechanical | ||
| # Connect locally | ||
| mechanical = pymechanical.Mechanical(port=10000) | ||
| # Or | ||
| # Connect remotely, to the IP address or hostname | ||
| mechanical = pymechanical.Mechanical( | ||
| "192.168.0.1", port=10000 | ||
| ) | ||
| ``` | ||
| ## Send commands to Mechanical | ||
| Run a single command: | ||
| ```{python} | ||
| #| eval: false | ||
| result1 = mechanical.run_python_script("2+3") | ||
| result2 = mechanical.run_python_script( | ||
| "DataModel.Project.ProjectDirectory" | ||
| ) | ||
| mechanical.run_python_script( | ||
| "Model.AddStaticStructuralAnalysis()" | ||
| ) | ||
| ``` | ||
| Evaluate a block of commands: | ||
| ```{python} | ||
| #| eval: false | ||
| # Import a material | ||
| commands = """ | ||
| cu_mat_file_path = ( | ||
| r'D:\Workdir\copper.xml'.replace("\\", "\\\\") | ||
| ) | ||
| materials = Model.Materials | ||
| materials.Import(cu_mat__file_path) | ||
| """ | ||
| mechanical.run_python_script(commands) | ||
| ``` | ||
| ## Execute a Python script: | ||
| ```{python} | ||
| #| eval: false | ||
| mechanical.run_python_script_from_file(file_path) | ||
| ``` | ||
| ## Import a Mechanical file and print the count of bodies: | ||
| ```{python} | ||
| #| eval: false | ||
| file = r"D:\\Workdir\\bracket.mechdb" | ||
| command = f'DataModel.Project.Open("{file}")' | ||
| mechanical.run_python_script(command) | ||
| mechanical.run_python_script(""" | ||
| allbodies = Model.GetChildren( | ||
| DataModelObjectCategory.Body, True) | ||
| """) | ||
| mechanical.run_python_script("allbodies.Count") | ||
| ``` | ||
| ## Perform project-specific operations: | ||
| ```{python} | ||
| #| eval: false | ||
| # Get the project directory | ||
| mechanical.project_directory | ||
| # List the files in the working directory. | ||
| mechanical.list_files() | ||
| # Save | ||
| mechanical.run_python_script( | ||
| "ExtAPI.DataModel.Project.Save(r'D:\\Workdir')") | ||
| # Log in two ways: | ||
| mechanical._log.info("This is a useful message.") | ||
| mechanical.log_message("INFO", "info message") | ||
| # Exit | ||
| mechanical.exit(force=True) | ||
| ``` | ||
|
|
||
| # Load a Mechanical embedded instance | ||
|
|
||
|
|
||
| ## Start an instance of App | ||
| ```{python} | ||
| #| eval: false | ||
| from ansys.mechanical.core import App | ||
| app = App(version=242) | ||
| print(app) | ||
| ``` | ||
| Extract and merge global API entry points: | ||
| ```{python} | ||
| #| eval: false | ||
| # Extract global API entry points from Mechanical | ||
| # Merge them into your Python global variables | ||
| app.update_globals(globals()) | ||
| ``` | ||
| Access entry points from Python: | ||
| ```{python} | ||
| #| eval: false | ||
| ExtAPI # Application.ExtAPI | ||
| DataModel # Application.DataModel | ||
| Model # Application.DataModel.Project.Model | ||
| Tree # Application.DataModel.Tree | ||
| Graphics # Application.ExtAPI.Graphics | ||
| ``` | ||
| Import a file and print the count of bodies | ||
| ```{python} | ||
| #| eval: false | ||
| file = r"D:\\Workdir\\bracket.mechdb" | ||
| app.open(file) | ||
| app.update_globals(globals()) | ||
| allbodies = Model.GetChildren( | ||
| DataModelObjectCategory.Body, True) | ||
| print(allbodies.Count) | ||
| ``` | ||
| ## Turn on warning logging: | ||
| ```{python} | ||
| #| eval: false | ||
| import logging | ||
| from ansys.mechanical.core import App | ||
| from ansys.mechanical.core.embedding.logger | ||
| import Configuration,Logger | ||
| Configuration.configure(level=logging.WARNING, | ||
| to_stdout=True) | ||
| app = App(version=242) | ||
| Logger.error("Test Error Message") | ||
| ``` | ||
| ## Visualize geometry in 3D: | ||
| ```{python} | ||
| #| eval: false | ||
| # requires Mechanical version >= 24R2 | ||
| app.plot() | ||
| ``` | ||
| ## Print project structure as tree: | ||
| ```{python} | ||
| #| eval: false | ||
| app.print_tree() | ||
| # print only 20 lines | ||
| app.print_tree(max_lines=20) | ||
| ``` | ||
|
|
||
| ```{python} | ||
| #| eval: false | ||
| ``` |
Oops, something went wrong.