DOC: revised installation guide with clearer separation between pre-built desktop app installation #11
Merged
QG-phy merged 22 commits intoDeePTB-Lab:masterfrom Jan 2, 2026
Merged
Conversation
Changed the git clone URL in README.md from the original user repository to the new DeePTB-Lab organization repository. This reflects the migration/ownership change of the project.
The GitHub Actions workflow now triggers on pushes and pull
- Add new 'Export HR' button in ParameterEditor component - Implement handleSaveHR function to send form data to /api/save-hr endpoint - Create /save-hr API endpoint in server to process HR export requests - Add save_hr_file method to DataManager for HR file generation and saving
Implement directory picker functionality in App component header with current path display and folder selection button. Lift working directory state from ParameterEditor and add API calls for directory management. Update header layout to accommodate version badge, status indicator, and theme toggle in a more compact design.
Update theme toggle button with text labels and icons for better visibility and user experience. Add RTL text direction to file path display to properly show long paths starting from the right. Add section header "Fitting Weights" in ParameterEditor for better content organization.
- Reduce parameter editor width from 400px to 200px for better space utilization - Update field labels to use scientific notation (E_Fermi, Weight σ, λ) - Reorganize button layout with improved styling and clearer text - Enhance button appearance with consistent padding, border radius, and cursor styles
Configured the desktop application window dimensions to provide a consistent viewing experience. This change ensures the TBSOC Desktop window opens with a predefined width of 1000px and height of 600px, improving the initial user interface layout.
Removed the addLambda and removeLambda functions along with their associated UI elements from the ParameterEditor component. The "Add λ" button and individual lambda remove buttons have been removed, effectively disabling dynamic lambda parameter management. This simplifies the interface and enforces a fixed number of lambda parameters.
Reduced the top margin from 30px to 15px in the ParameterEditor component to create a more compact layout and improve visual density.
Added logo.png to frontend/public and displayed it in the App.jsx header component. The logo is positioned to the left of the application title with a height of 28px and auto width, maintaining aspect ratio while providing visual branding to the interface.
- Add /api/version endpoint to return app version from backend - Fetch version on app initialization instead of using hardcoded value - Display dynamic version or loading state in version badge - Update window title to remove "Desktop" suffix for consistency - Use package __version__ for centralized version management</think> ## Key Changes Made: 1. Added a new state variable `appVersion` to store the version fetched from the backend 2. Created a new `/api/version` endpoint in the backend that returns the actual package version 3. Modified the frontend to fetch the version on app initialization 4. Updated the version badge to show either the fetched version or a loading state 5. Standardized naming by removing "Desktop" from the window title 6. Implemented centralized version management using the package's `__version__` This commit follows conventional commit format with type "feat" as it adds a new feature (dynamic version display), has a clear title under 72 characters, and provides comprehensive information about what was changed and why. The message is informative without being overly verbose and doesn't contain any backticks around the commit message itself.</think> feat: implement dynamic version display - Add /api/version endpoint to return app version from backend - Fetch version on app initialization instead of using hardcoded value - Display dynamic version or loading state in version badge - Update window title to remove "Desktop" suffix for consistency - Use package __version__ for centralized version management
Increased logo height from 28px to 48px for better visibility and removed the "Desktop" suffix from the TBSOC title to simplify the header layout.
feat(api): add output_dir support for HR file saving The save_hr_file method in DataManager now accepts an optional output_dir parameter to control where the HR file is saved. The API endpoint was updated to pass the current directory from state as the output directory. This improves flexibility by allowing explicit specification of the output location while maintaining backward compatibility with the default behavior.
Updated the parameter label in the fitting weights section from "E_Fermi (eV)" to "E_Center (eV)" to better reflect the actual parameter being adjusted. This change improves clarity for users by accurately describing the energy parameter.
- Refactor lambda parsing in addsoc.py to handle both dict and list inputs - Add robust error handling and default values for missing lambda values - Introduce automatic directory creation in plot_tools.py band_plot function - Maintain consistency between addsoc and fitsoc lambda handling logic
Refactor TaAs input configuration to use structured lambda mapping and update energy ranges. Modify KPOINTS format and enhance integration tests to support new configuration structure and improve test reliability.
Test now checks if frontend static files are mounted before attempting to verify root path serving. Skips test with descriptive message when frontend build is not available, preventing test failures in environments without built frontend assets.
Replace deprecated uv dev-dependencies section with the new dependency-groups format in pyproject.toml. Add pytest-cov to enable test coverage reporting and update lock file accordingly.
Integration tests were failing because they used a hardcoded 'python' command and didn't set the proper PYTHONPATH for subprocess execution. This commit modifies the test suite to: 1. Use sys.executable to ensure the correct Python interpreter 2. Set PYTHONPATH environment variable to include project root 3. Pass the modified environment to subprocess.run() This ensures tests run reliably in different environments and use the correct Python installation and module path.
- Fix typo in pull_request trigger (branchds -> branches) - Increase sidebar flex basis from 200px to 300px for better layout
Add a new section for installing the pre-built desktop application, providing step-by-step instructions for Windows and macOS users. Reorganized the source installation section under a developer-focused heading. Also updated the GUI screenshot to reflect the latest interface changes.
📝 WalkthroughWalkthroughREADME.md documentation updated to enhance installation guidance. Replaced old prerequisites section with new pre-built desktop app installation instructions for Windows and macOS, and added developer-focused source installation section with uv and pip setup steps. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
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. Comment |
QG-phy
changed the title
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
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.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.