Skip to content

Add files via upload #128

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 27, 2025
Merged

Add files via upload #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions 2025R1/Rocky-PrePost-scripting-Manual-2025-R1/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# Release notes for 2025 R1

<a id="added"></a>
Expand All @@ -6,7 +8,7 @@

<a id="new-methods"></a>

### New methods
### New Methods

* `RockyApiApplication`
* `GetVersion` - This method return the current application version `app.GetVersion()`.
Expand All @@ -20,10 +22,6 @@
* [`IsPeriodicEnabled`](RAVolumetricInlet.md#generated.RAVolumetricInlet.IsPeriodicEnabled)
* [`SetPeriod`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetPeriod)
* [`GetPeriod`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetPeriod)
* [`GetPeriodicStop`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetPeriodicStop)
* [`SetPeriodicStop`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetPeriodicStop)
* [`GetInjectionTime`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetInjectionTime)
* [`SetInjectionTime`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetInjectionTime)
* [`RAStudy`](RAStudy.md)
* [`GetProgress`](RAStudy.md#generated.RAStudy.GetProgress)
* [`RAParticles`](RAParticles.md)
Expand Down Expand Up @@ -102,7 +100,7 @@

<a id="new-classes"></a>

### New classes
### New Classes

* [`RAFilterProcess`](RAFilterProcess.md) - This class allows filtering properties by a cut or range of values. Replaces `RAPropertyProcess`.
* [`RAResidenceTime`]() - This class allows manipulating Residence Time Calculators in a project.
Expand Down
11 changes: 6 additions & 5 deletions 2025R1/Rocky-PrePost-scripting-Manual-2025-R1/setup-ide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Using VScode to create/edit scripts


# Using VScode to Create/Edit Scripts

For more complex PrePost Scripting scripts, we suggest you to use a Python IDE, so you get features like
syntax highlight and code completion. You can use any IDE, but Visual Studio Code (a.k.a. VSCode) has good Python
support, it’s lightweight and free.

Rocky provides Python interface files (.pyi) that can be used by the IDE to enable code completion
for PrePost Scripting classes. For windows, these files are located usually in `"C:/Program Files/ANSYS Inc/v242/Rocky/bin"`.
for PrePost Scripting classes. For windows, these files are located usually in `"C:/Program Files/ANSYS Inc/v251/Rocky/bin"`.
In Linux, the “bin” folder is in the same folder where the Rocky .tbz2 installation package was extracted.

To configure auto-completion for PrePost scripts in VSCode proceed as following:
Expand All @@ -19,11 +21,11 @@ To configure auto-completion for PrePost scripts in VSCode proceed as following:
```json
{
"python.autoComplete.extraPaths": [
"C:/Program Files/ANSYS Inc/v242/Rocky/bin/prepost_scripting_stubs",
"C:/Program Files/ANSYS Inc/v251/Rocky/bin/prepost_scripting_stubs",
],

"python.analysis.extraPaths": [
"C:/Program Files/ANSYS Inc/v242/Rocky/bin/prepost_scripting_stubs",
"C:/Program Files/ANSYS Inc/v251/Rocky/bin/prepost_scripting_stubs",
]
}
```
Expand All @@ -32,7 +34,6 @@ Now the autocomplete is available. Create a new python file like “script_A.py
start writing your scripts:

```python3
from rocky30.plugins.api.rocky_api_application import RockyApiApplication as app
from rocky30.plugins.api.ra_project import RAProject

project: RAProject = app.CreateProject()
Expand Down