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 docs: overview and RTE equations #327

Merged
merged 1 commit into from
Jan 31, 2023
Merged

Add docs: overview and RTE equations #327

merged 1 commit into from
Jan 31, 2023

Conversation

szy21
Copy link
Member

@szy21 szy21 commented Jan 24, 2023

Purpose

Add overview and RTE to the docs. Closes #328. Note that I was trying to follow the code when there are discrepancies between the code and the paper. Please click on documenter/deploy at the bottom of this page to see the docs.

To-do

Content


  • I have read and checked the items on the review checklist.

@szy21 szy21 force-pushed the zs/docs_rce branch 2 times, most recently from 26731c4 to d292fbe Compare January 30, 2023 20:03
@szy21 szy21 marked this pull request as ready for review January 30, 2023 20:04
@szy21 szy21 changed the title Add docs: overview and RCE equations Add docs: overview and RTE equations Jan 30, 2023
@szy21 szy21 requested a review from tapios January 30, 2023 20:09
Copy link
Collaborator

@tapios tapios left a comment

Choose a reason for hiding this comment

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

Looking good. Thanks!

docs/src/RTE.md Outdated Show resolved Hide resolved
docs/src/RTE.md Outdated Show resolved Hide resolved
docs/src/RTE.md Outdated Show resolved Hide resolved
docs/src/RTE.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
@szy21 szy21 force-pushed the zs/docs_rce branch 2 times, most recently from b83249e to 343ce87 Compare January 31, 2023 00:09
@szy21
Copy link
Member Author

szy21 commented Jan 31, 2023

bors r+

@bors
Copy link
Contributor

bors bot commented Jan 31, 2023

@bors bors bot merged commit 851f13e into main Jan 31, 2023
@bors bors bot deleted the zs/docs_rce branch January 31, 2023 00:25
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.

Add docs: overview and RTE equations
2 participants