Skip to content

[Docs] Update outdated info on website FAQ #2704

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.

Sign up for GitHub

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

Merged
jonwzheng merged 12 commits into from
Aug 12, 2024
Merged

[Docs] Update outdated info on website FAQ #2704

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e7db626
remove outdated info from faq docs
jonwzheng Aug 6, 2024
aac2e43
update credits documentation author list
jonwzheng Aug 6, 2024
0d5b2ab
update dependencies documentation
jonwzheng Aug 6, 2024
b107bdc
update kinetics database to point to RMG website rather than include …
jonwzheng Aug 6, 2024
0ad079d
fix typo in rmg thermo documentation
jonwzheng Aug 6, 2024
5ba15ba
update arkane credits list
jonwzheng Aug 6, 2024
53a3ae5
change credits to point to CITATIONS.bib
jonwzheng Aug 8, 2024
9c37704
add disclaimer to docs to give rmg website a few minutes to load
jonwzheng Aug 8, 2024
b4f218e
update FAQ and dependencies with code review comments
jonwzheng Aug 8, 2024
7c09426
polish docs formatting
jonwzheng Aug 9, 2024
97dc9fb
Apply suggestions from code review
jonwzheng Aug 9, 2024
0f67156
apply review comments; adjust credits
jonwzheng Aug 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions documentation/source/users/arkane/credits.rst
View file
Open in desktop
Comment thread
jonwzheng marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Developers: (rmg_dev@mit.edu)
- Dr. R.J. Gillis
- Dr. A.M. Payne
- Asst. Prof. Y.-P. Li
Comment thread
jonwzheng marked this conversation as resolved.
Outdated
- X. Dong
- K.A. Spiekermann
- Dr. X. Dong
- Dr. K.A. Spiekermann
- H. Wu
- Dr. E.E. Dames
- Dr. Z.J. Buras,
Expand All @@ -41,11 +41,4 @@ Developers: (rmg_dev@mit.edu)
How to Cite
***********

A. Grinberg Dana, M.S. Johnson, J.W. Allen, S. Sharma, S. Raman, M. Liu, C.W. Gao, C.A. Grambow, M.J. Goldman,
D.S. Ranasinghe, R.J. Gillis, A.M. Payne, Y.-P. Li, X. Dong, K.A. Spiekermann, H. Wu, E.E. Dames, Z.J. Buras,
N.M. Vandewiele, N.W. Yee, S.S. Merchant, B. Buesser, C.A. Class, C.F. Goldsmith, R.H. West, W.H. Green,
"Automated reaction kinetics and network exploration (Arkane):
A statistical mechanics, thermodynamics, transition state theory, and master equation software",
*International Journal of Chemical Kinetics* 2023, 55(6), 300-323.

DOI: `10.1002/kin.21637 <https://doi.org/10.1002/kin.21637>`_
Please refer to the `CITATIONS.bib file <https://github.com/ReactionMechanismGenerator/RMG-Py/blob/main/CITATIONS.bib>`_.
Copy link
Copy Markdown
Member

@rwest rwest Aug 9, 2024

Choose a reason for hiding this comment

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

Could maybe add to that file comments about when to cite what. But maybe that's not helpful, or already obvious.

Copy link
Copy Markdown
Member Author

@jonwzheng jonwzheng Aug 9, 2024

Choose a reason for hiding this comment

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

added a brief mention of which to use

35 changes: 8 additions & 27 deletions documentation/source/users/rmg/credits.rst
View file
Open in desktop
Comment thread
jonwzheng marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,14 @@ Project Supervisors:

Current Developers: (rmg_dev@mit.edu)

- Dr. Alon Grinberg Dana
- Prof. Alon Grinberg Dana
- Dr. Matt Johnson
- Yen-Ting Wang
- Xiaorui Dong
- Hao-Wei Pang
- Dr. Anna Doner
- Oscar Wu
- Kevin Spiekermann
- Jonathan Zheng
- Jackson Burns
- Nathan Morgan
- Prof. Richard H. West
- Prof. C. Franklin Goldsmith
- Dr. Katrin Blondal
Comment thread
jonwzheng marked this conversation as resolved.
Outdated
- Dr. Bjarne Kreitz
Comment thread
jonwzheng marked this conversation as resolved.
Expand All @@ -35,6 +33,10 @@ Current Developers: (rmg_dev@mit.edu)

Previous Developers:

- Dr. Xiaorui Dong
- Dr. Hao-Wei Pang
- Dr. Kevin Spiekermann
- Yen-Ting Wang
- Dr. Joshua W. Allen
- Dr. Yunsie Chung
Comment thread
jonwzheng marked this conversation as resolved.
- Dr. David Farina
Expand Down Expand Up @@ -66,25 +68,4 @@ Previous Developers:
How to Cite
***********

C.W. Gao, J.W. Allen, W.H. Green, R.H. West,
"Reaction Mechanism Generator: Automatic construction of chemical kinetic mechanisms",
*Computer Physics Communications* 2016, 203, 212-225.

DOI: `10.1016/j.cpc.2016.02.013 <https://doi.org/10.1016/j.cpc.2016.02.013>`_


M. Liu, A. Grinberg Dana, M.S. Johnson, M.J. Goldman, A. Jocher, A.M. Payne, C.A. Grambow, K. Han, N.W. Yee,
E.J. Mazeau, K. Blondal, R.H. West, C.F. Goldsmith, W.H. Green,
"Reaction Mechanism Generator v3.0: Advances in Automatic Mechanism Generation",
*Journal of Chemical Information and Modeling* 2021, 61(6), 2686–2696.

DOI: `10.1021/acs.jcim.0c01480 <https://doi.org/10.1021/acs.jcim.0c01480>`_



M.S. Johnson, X. Dong, A. Grinberg Dana, Y. Chung, D. Farina, R.J. Gillis, M. Liu, N.W. Yee, K. Blondal,
E. Mazeau, C.A. Grambow, A.M. Payne, K.A. Spiekermann, H.-W. Pang, C.F. Goldsmith, R.H. West, W.H. Green,
"The RMG Database for Chemical Property Prediction",
*Chemical Information* 2022, 62(20), 4906–4915.

DOI: `10.1021/acs.jcim.2c00965 <https://doi.org/10.1021/acs.jcim.2c00965>`_
Please refer to the `CITATIONS.bib file <https://github.com/ReactionMechanismGenerator/RMG-Py/blob/main/CITATIONS.bib>`_.
Loading