Add citation info, supported supercomputer list, and documentation fixes - #2
Open
k-yoshimi wants to merge 5 commits into
Open
Add citation info, supported supercomputer list, and documentation fixes#2k-yoshimi wants to merge 5 commits into
k-yoshimi wants to merge 5 commits into
Conversation
- Add a Citation section (paper reference + BibTeX for doi:10.1080/27660400.2025.2564055) to README and the ja/en manuals - List supercomputer systems where moller is pre-installed (ISSP kugui/ohtaka, Tohoku AOBA, Kyushu Genkai) and note that Miyabi is supported with pre-installation in progress, with links to each system's website (English pages in English documents) - Add acknowledgment of JST Moonshot R&D Program (JPMJMS24A3) for the Miyabi/Genkai installations - Unify license notation to GPL-3.0-or-later across README and manuals - Document pbs/default platform values in the file-format reference - Fix typos (Institute, Coordinator, parallel, batch), a broken inline literal, a duplicate Sphinx label, and tab characters in YAML examples; ja/en manuals now build with zero warnings - Add CLAUDE.md with repository guidance for Claude Code Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012Ar4PAN3bT9pEL8rj8txNc
There was a problem hiding this comment.
Pull request overview
This PR updates moller’s user-facing documentation to include formal citation information, clarify supported/pre-installed supercomputer environments, and fix a set of typos / Sphinx formatting issues (including removing a duplicate Sphinx label). It also adds a CLAUDE.md repository guidance file.
Changes:
- Add citation text + BibTeX entry to the top-level README and both JA/EN manuals, and add an acknowledgment for supported installations.
- Document additional accepted
systemvalues (pbs,default) in the file-format reference and clean up YAML example formatting (tabs/indentation). - Fix documentation typos and Sphinx issues (broken inline literal, duplicate
sec-tutoriallabel).
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sample/moller/simple/README.md | Fixes a typo (“paralle” → “parallel”) in the sample README. |
| README.md | Adds supported/pre-installed system list, acknowledgement, citation section, and unifies license wording to GPL-3.0-or-later. |
| docs/ja/source/moller/tutorial/index.rst | Removes duplicate sec-tutorial label to eliminate Sphinx warning. |
| docs/ja/source/moller/tutorial/basic.rst | Fixes typo in parameter description (paralle → parallel). |
| docs/ja/source/moller/filespec/index.rst | Documents pbs/default for system and cleans YAML example indentation/tabs. |
| docs/ja/source/moller/about/index.rst | Adds license notation clarification, citation section, acknowledgments, and pre-installed system list (JA). |
| docs/en/source/moller/tutorial/basic.rst | Fixes broken inline literal around output. |
| docs/en/source/moller/filespec/index.rst | Fixes typo (“betch” → “batch”), documents pbs/default, and cleans indentation/tabs in examples. |
| docs/en/source/moller/about/index.rst | Fixes typos, clarifies license notation, adds citation + acknowledgment, and lists pre-installed systems (EN). |
| CLAUDE.md | Adds repository architecture/maintenance guidance for Claude Code usage in this repo. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Release, license (GPL-3.0-or-later), docs-deploy workflow status, Python version, and paper DOI. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012Ar4PAN3bT9pEL8rj8txNc
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012Ar4PAN3bT9pEL8rj8txNc
Separate script-generation targets from the pre-installed systems, which are now shown in a table with site and status columns. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012Ar4PAN3bT9pEL8rj8txNc
Align the ja/en about pages with the README: system, operating site, and installation status in one list-table. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012Ar4PAN3bT9pEL8rj8txNc
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
pbsanddefaultvalues of thesystemparameter in addition toohtaka/kugui.sec-tutorialin the ja tutorial), and tab characters in YAML examples. Both ja/en manuals now build with zero Sphinx warnings.CLAUDE.mdwith repository guidance for Claude Code.Verification
make -C docs/en htmlandmake -C docs/ja htmlsucceed with no warnings;make latexpdfalso builds for both languages.system:values) is intentionally omitted due to the confidentiality policy above.🤖 Generated with Claude Code
https://claude.ai/code/session_012Ar4PAN3bT9pEL8rj8txNc