Molara-Lab / Molara

Molara is a Python package for the visualization of chemical structures such as molecules or crystals. It provides a graphical user interface for importing structures from output files of popular computational chemistry software as well as for creating custom structures.
GNU General Public License v3.0
11 stars 0 forks source link

Add molara logo #397

Open Michel-Heinz opened 1 month ago

Michel-Heinz commented 1 month ago

I added the .svg and .png file of the molara logo to the repo. I excluded some codespell string. @ab5424 can you check that please?

coderabbitai[bot] commented 1 month ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates focus on enhancing the user interface and packaging of the Molara project. Changes include the addition of a logo in the README and application icon, adjustments to file inclusion for packaging, and an update to spell-check settings to exclude SVG files.

Changes

File(s) Summary of Changes
.pre-commit-config.yaml, MANIFEST.in Updated to exclude .svg files and include .json files and logo image for packaging.
README.md, src/.../__main__.py Introduced project logo in README and as application window icon.
src/.../__main__.py, tests/.../test_main_program.py Enhanced GUI features and added relevant tests.

Poem

🐰✨
In the code where bytes align,
A logo shines, pure and fine.
With each commit, we refine,
Crafting code that's near divine.
Hop along the binary vine! 🌿🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 50.00000% with 5 lines in your changes are missing coverage. Please review.

Project coverage is 79.16%. Comparing base (0ef5cc3) to head (eb9dd54).

Files Patch % Lines
src/molara/__main__.py 50.00% 5 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #397 +/- ## ========================================== + Coverage 78.69% 79.16% +0.46% ========================================== Files 45 45 Lines 3975 3978 +3 ========================================== + Hits 3128 3149 +21 + Misses 847 829 -18 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

ab5424 commented 1 month ago

@Michel-Heinz codespell is ok. The png file look horrible for it's size though.

Michel-Heinz commented 1 month ago

@Michel-Heinz codespell is ok. The png file look horrible for it's size though.

Yes it does I ll fix it

Michel-Heinz commented 1 month ago

The molara logo will now be displayed instead of the default python logo in the taskbar when using the program. I also refworked the logo for better resolution feel free to merge!

Michel-Heinz commented 1 month ago

@ab5424 this is read to merge. I propose we ignore the code cov, since the coverage is increased by this patch and we cannot test the main routine anyway, because we cannot close the program in tests due to the event loop.

ab5424 commented 1 month ago

@Michel-Heinz For me it works on MacOS, but not on Windows (still shows the default python logo in the taskbar). I think this is a known problem: https://stackoverflow.com/questions/12432637/setting-the-windows-taskbar-icon-in-pyqt Shall we still merge and open a new issue or do you want to fix this now?

Michel-Heinz commented 1 month ago

I d like to merge now and fix this later on windows. I currently do not have a windows computer on hand.

ab5424 commented 1 month ago

@Michel-Heinz You can use the Windows Cluster (https://help.itc.rwth-aachen.de/service/t4ibytwt1n3p/article/142725a3a4f14e4cbb0c66e00bacfbf7/), at least until 01. July when it will be discontinued.

ab5424 commented 1 month ago

@Michel-Heinz The logo (and json files) are now included in the build, but there is still something missing when installing the wheel:


(Molara) alexbonkowski@182-151 Molara % molara examples/xyz/ferrocene.xyz                                      
Traceback (most recent call last):
  File "/Users/alexbonkowski/PycharmProjects/venv/Molara/bin/molara", line 8, in <module>
    sys.exit(main())
  File "/Users/alexbonkowski/PycharmProjects/venv/Molara/lib/python3.9/site-packages/molara/__main__.py", line 36, in main
    widget = MainWindow()
  File "/Users/alexbonkowski/PycharmProjects/venv/Molara/lib/python3.9/site-packages/molara/Gui/main_window.py", line 57, in __init__
    self.structure_customizer_dialog = StructureCustomizerDialog(self)
  File "/Users/alexbonkowski/PycharmProjects/venv/Molara/lib/python3.9/site-packages/molara/Gui/structure_customizer_dialog.py", line 43, in __init__
    self.update_settings_box()
  File "/Users/alexbonkowski/PycharmProjects/venv/Molara/lib/python3.9/site-packages/molara/Gui/structure_customizer_dialog.py", line 77, in update_settings_box
    for f in listdir(f"{self.src_path}/Settings/Structure")
FileNotFoundError: [Errno 2] No such file or directory: '/Users/alexbonkowski/PycharmProjects/venv/Molara/lib/python3.9/Settings/Structure'
ab5424 commented 1 month ago

I assume this will be changed anyway when we shift the settings file to home?