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

new notebooks and python scripts for quick start also fixed crm notebook #629

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from

Conversation

wiktor-flex
Copy link
Collaborator

@wiktor-flex wiktor-flex commented Dec 18, 2024

Added jupyter notebooks and python scripts for quick start:

  • automated meshing
  • nrel s809
  • om6wing
  • xv15
    Corrected the 2D CRM notebook

@wiktor-flex wiktor-flex self-assigned this Dec 18, 2024
@wiktor-flex wiktor-flex changed the title new notebooks for quick start and fixed crm notebook new notebooks and python scripts for quick start also fixed crm notebook Jan 9, 2025
@wiktor-flex wiktor-flex reopened this Jan 29, 2025
Copy link
Contributor

Choose a reason for hiding this comment

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

For this file:

  1. After code cell 6, "Another option to create a project is to use a file of your choice by using:"
  2. After code cell 15, "Finally we will take a look at how forces changed throughout the calculation of the simulation."
  3. Last Markdown block: visity -> visit

General comments for the other notebooks:

  1. Please also check other grammar errors.
  2. When plotting the results using, for instance, cfl.plot(x='pseudo_step', y=["0_NavierStokes_cfl", "1_SpalartAllmaras_cfl"]), can you also show how to get the available keys/column names for setting up x and y here?
  3. Can you also use project.print_project_tree() to print out the project tree after the case is finished. Maybe also explain that the asset can be accessed using the shortID shown in the printed tree? For example, case = project.get_case(asset_id=)

Copy link
Contributor

Choose a reason for hiding this comment

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

  1. In the "post processing" markdown block, ran -> run
  2. Do we still need to keep the complete code section at the end? I think we already have the complete code in the separate python script. Also, the other notebooks do not have this section.

Copy link
Contributor

Choose a reason for hiding this comment

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

In "Simulation parameters" markdown block: paramas -> params

@wiktor-flex
Copy link
Collaborator Author

On hold until there is a decision as to what to do with the examples included here after the documentation changes

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

Successfully merging this pull request may close these issues.

2 participants