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

docs: add example notebooks for sweeps, map, and scale #1083

Closed
wants to merge 2 commits into from

Conversation

dastan-ansys
Copy link
Contributor

Description

Added example notebooks for sweep_sktech, sweep_chain, map, and scale.

Issue linked

Issue: 1049

Checklist

  • I have tested my changes locally.
  • I have added necessary documentation or updated existing documentation.
  • I have followed the coding style guidelines of this project.
  • I have added appropriate unit tests.
  • I have reviewed my changes before submitting this pull request.
  • I have linked the issue or issues that are solved to the PR if any.
  • I have assigned this PR to myself.
  • I have added the minimum version decorator to any new backend method implemented.
  • I have made sure that the title of my PR follows Conventional commits style (e.g. feat: extrude circle to cylinder)

@dastan-ansys dastan-ansys self-assigned this Mar 25, 2024
@dastan-ansys dastan-ansys requested review from PipKat and a team as code owners March 25, 2024 18:34
@dastan-ansys dastan-ansys linked an issue Mar 25, 2024 that may be closed by this pull request
4 tasks
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 25, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Mar 25, 2024
m = Modeler()
```

## Scale Body
Copy link
Contributor

Choose a reason for hiding this comment

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

Only thoughts on the scale body section: maybe it would be better to make copies and scale the copies and plot them all together so the user can see the difference (plotting one body at a time doesn't have an immediate visual difference between them)

# Create the circlular profile on the XZ-plane centered at (5, 0, 0) with radius 2
profile = Sketch(plane=Plane(direction_x=[1, 0, 0], direction_y=[0, 0, 1])).circle(
Point2D([path_radius, 0]), profile_radius
)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
)
)
profile.plot()

Might as well show the sketch in the plotter for better visualization.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.22%. Comparing base (9020717) to head (3fa2141).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1083   +/-   ##
=======================================
  Coverage   90.22%   90.22%           
=======================================
  Files          93       93           
  Lines        6835     6835           
=======================================
  Hits         6167     6167           
  Misses        668      668           

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

@RobPasMue
Copy link
Member

@dastan-ansys - branch has to be named as docs/... and not docs.... Please, rename branch and open a new PR

@dastan-ansys dastan-ansys deleted the docsAdd-examples-on-new-methods branch April 1, 2024 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add examples on new methods
5 participants