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 physics write-ups to the git #55

Open
shaimach opened this issue Feb 16, 2021 · 0 comments
Open

Add physics write-ups to the git #55

shaimach opened this issue Feb 16, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@shaimach
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
We have/are generating write-ups of relevant physics ahead of coding (e.g. non-Markovian dynamics, SU(4) structure for co-design, etc) The code isn't really understandable without this supporting material. And unless we have these in the git, putting the write-up alongside the code which implements it, we'll lose track over time.

Describe the solution you'd like
Create the write-up in whatever tool you like.
When code based on this write-up goes into the repository, so should the write-up.

Describe alternatives you've considered
Wiki. But it needs some version control that matches the code versioning.

@lazyoracle lazyoracle added the documentation Improvements or additions to documentation label Feb 16, 2021
@lazyoracle lazyoracle added good first issue Good for newcomers help wanted Extra attention is needed labels Feb 20, 2021
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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants