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

Suggestions for contribution #90

Open
Ruberhauptmann opened this issue Apr 16, 2024 · 0 comments
Open

Suggestions for contribution #90

Ruberhauptmann opened this issue Apr 16, 2024 · 0 comments

Comments

@Ruberhauptmann
Copy link

I just discovered this package and used it to generate some graphics for my masters thesis (graphene, but with the basis rotated in comparison to the predefined one to be in line with my definition) . It absolutely saved me a lot of work doing things myself, but I struggled a bit with the documentation, so I would like to contribute to that a bit.

I can imagine adding the following:

  • My code as an example somewhere, to illustrate how to create lattice and BZ graphics
  • API Documentation where its missing
  • Typehints

Also, I couldn't really figure out how to use the things provided in lattpy.disptools, so I did plotting of bands myself. If you have any hints, I can also add that to the documentation.

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

No branches or pull requests

1 participant