Update citation in README.md #240
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Orion Cohen <27712051+orionarcher@users.noreply.github.com>
WalkthroughDocumentation-only update: the README's Citation section was edited to replace a Zenodo citation prompt with an arXiv preprint link (https://arxiv.org/abs/2508.06628). No code, API, or exported-entity changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: CodeRabbit UI 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (52)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
137-137: Capitalize “arXiv” and tighten phrasingMinor editorial fix for correctness and style.
Apply this diff:
-If you use TorchSim in your research, please cite it on [arxiv](https://arxiv.org/abs/2508.06628). +If you use TorchSim in your research, please cite the [arXiv preprint](https://arxiv.org/abs/2508.06628).
7-10: Clarify relationship between arXiv and Zenodo referencesYou’ve switched the citation text to arXiv, but the README still prominently displays a Zenodo badge and reference. If both are intended (common pattern: cite the paper via arXiv and reference specific software releases via Zenodo DOI), make that explicit to avoid confusion.
Optionally expand the Citation section:
-## Citation - -If you use TorchSim in your research, please cite the [arXiv preprint](https://arxiv.org/abs/2508.06628). +## Citation + +If you use TorchSim in your research, please cite: + +- the arXiv preprint: [arXiv:2508.06628](https://arxiv.org/abs/2508.06628) +- and, for specific software versions, the corresponding release on [Zenodo][zenodo]If Zenodo is no longer desired, consider removing the badge and link reference at Lines 7–10 to keep signals consistent.
Also applies to: 135-138
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~137-~137: There might be a mistake here.
Context: ...rxiv](https://arxiv.org/abs/2508.06628).
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: test-model (macos-14, 3.11, highest, sevenn, tests/models/test_sevennet.py)
- GitHub Check: test-model (macos-14, 3.11, highest, orb, tests/models/test_orb.py)
- GitHub Check: test-model (macos-14, 3.11, highest, fairchem, tests/models/test_fairchem.py)
- GitHub Check: build-docs
🔇 Additional comments (1)
README.md (1)
135-138: Add BibTeX snippet to README and CITATION.cff for citationIncluding the official BibTeX entry in the README and a CITATION.cff file improves discoverability and ensures proper attribution.
- In README.md (lines 135–142), append this under the existing Citation section:
## Citation If you use TorchSim in your research, please cite it on [arXiv](https://arxiv.org/abs/2508.06628). + +#### BibTeX + +```bibtex +@article{TorchSim2025, + title = {TorchSim: An efficient atomistic simulation engine in PyTorch}, + author = {Orion Cohen and Janosh Riebesell and Rhys Goodall and Adeesh Kolluru and Stefano Falletta and Joseph Krause and Jorge Colindres and Gerbrand Ceder and Abhijeet S. Gangan}, + journal = {arXiv preprint arXiv:2508.06628}, + year = {2025}, + archivePrefix = {arXiv}, + eprint = {2508.06628}, + primaryClass = {physics.comp-ph} +} +```
- Create a new file
CITATION.cffat the repo root with the following content:cff-version: "1.2.0" title: "TorchSim: An efficient atomistic simulation engine in PyTorch" authors: - family-names: Cohen given-names: Orion - family-names: Riebesell given-names: Janosh - family-names: Goodall given-names: Rhys - family-names: Kolluru given-names: Adeesh - family-names: Falletta given-names: Stefano - family-names: Krause given-names: Joseph - family-names: Colindres given-names: Jorge - family-names: Ceder given-names: Gerbrand - family-names: Gangan given-names: Abhijeet S. date-released: "2025-08-??" url: "https://arxiv.org/abs/2508.06628" # doi: <ZENODO_DOI> # uncomment or add your Zenodo DOI if desiredPlease confirm if you’d like to include the Zenodo DOI in CITATION.cff (and provide it), and I’ll update accordingly.
Signed-off-by: Orion Cohen <27712051+orionarcher@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the citation link in the README to point to the arxiv manuscript
Summary by CodeRabbit