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

Add examples for custom generators #17

Merged
merged 10 commits into from
Jul 8, 2024
Merged

Add examples for custom generators #17

merged 10 commits into from
Jul 8, 2024

Conversation

DomFijan
Copy link
Contributor

@DomFijan DomFijan commented Jul 4, 2024

Description

Adds example with custom generators.

Motivation

Custom generators are somewhat convoluted, but with a couple of examples they are easy to use.

Have you (if appropriate)

  • Updated changelog
  • Updated Documentation
  • Add tests
  • Added name to contributors

@DomFijan DomFijan requested a review from janbridley July 4, 2024 20:23
@DomFijan DomFijan linked an issue Jul 4, 2024 that may be closed by this pull request
7 tasks
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be better to include the simulation data as an uncompressed format like xyz? It makes the reading code more complicated but could be useful for non glotzerlab members. Can be discussed offline, as this is great as is.

@DomFijan DomFijan marked this pull request as ready for review July 8, 2024 21:02
@DomFijan DomFijan requested review from a team and janbridley July 8, 2024 21:02
Copy link
Contributor

@janbridley janbridley left a comment

Choose a reason for hiding this comment

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

Looks great!

@DomFijan DomFijan merged commit ead4ad6 into main Jul 8, 2024
8 checks passed
@DomFijan DomFijan deleted the add_custom_example branch July 8, 2024 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Further Documentation Improvements
2 participants