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/assy: add constraints #850

Merged
merged 14 commits into from
Sep 2, 2021
Merged

doc/assy: add constraints #850

merged 14 commits into from
Sep 2, 2021

Conversation

marcus7070
Copy link
Member

@marcus7070 marcus7070 commented Aug 18, 2021

Will resolve #715.

This is still a WIP, but it's mostly done and I won't be able to get back to it for a few days, so I figured I'd open this draft PR incase anyone wants to check it out.

Still to do:

  • Consider a more gentle introduction to constraints (Why you would use them? Define what I mean when I say first object, second object?)
  • Introduce dummy geometry Introduce dummy Shapes in the assembly docs #856
  • Run my code examples through black
  • Is that Plane 3D example really worth it? Should I just replace it with a 3 line code block?
  • Explain why rotation has to be locked with PointInPlane, but you can get away without doing it for just Point Not going to add this, it reads better without it
  • Consider applying better formatting to the list of colors (flexbox or something?)
  • Docstring at the top of gen_colors.py, it's not obvious what it's used for
  • Explain initial locations

@Jojain
Copy link
Contributor

Jojain commented Aug 18, 2021

It could be nice to have a note that says something like :

  • Since solve() is computing an optimization, it is sensible to initials parameters. Thus having your shapes positioned roughly were you want them to be can give better results/ make the assembly converge. Especially if all your parts are overlapping at the beginning.

(I am not 100% sure this is true though lol)

@marcus7070
Copy link
Member Author

  • Since solve() is computing an optimization, it is sensible to initials parameters. Thus having your shapes positioned roughly were you want them to be can give better results/ make the assembly converge. Especially if all your parts are overlapping at the beginning.

Thanks @Jojain. Yeah, I won't word it exactly like that (I think no initial locations is fine for the majority of uses), but if I'm explaining how constraints work then I should also explain initial locations as well.

@marcus7070 marcus7070 marked this pull request as ready for review August 30, 2021 12:25
@jmwright
Copy link
Member

jmwright commented Sep 1, 2021

@marcus7070 Still seeing the following black error in CI.

would reformat doc\conf.py
Oh no! \U0001f4a5 \U0001f494 \U0001f4a5
1 file would be reformatted, 67 files would be left unchanged.
Command exited with code 1

Copy link
Member

@jmwright jmwright left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @marcus7070 !

Copy link
Member

@adam-urbanczyk adam-urbanczyk left a comment

Choose a reason for hiding this comment

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

Great, looks good! Just one more black run and all should be green.

@marcus7070
Copy link
Member Author

@marcus7070 Still seeing the following black error in CI.

would reformat doc\conf.py
Oh no! \U0001f4a5 \U0001f494 \U0001f4a5
1 file would be reformatted, 67 files would be left unchanged.
Command exited with code 1

Thanks, I just had to add a comma to a list. Assuming this all passes I'll merge in a few minutes.

@marcus7070
Copy link
Member Author

Just a leftover error because this branch doesn't contain #872, so I'll merge.

@marcus7070 marcus7070 merged commit 0b2a075 into master Sep 2, 2021
@marcus7070 marcus7070 deleted the marcus7070/constraint-docs branch September 2, 2021 01:55
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.

Documentation & examples for each assembly constraint
4 participants