FAIRmat-NFDI / nomad-perovskite-solar-cells-database

A NOMAD plugin containing the schema for the Perovskite Solar Cell Database.
https://fairmat-nfdi.github.io/nomad-perovskite-solar-cells-database/
Apache License 2.0
3 stars 1 forks source link

Add scatter plot #37

Closed Pepe-Marquez closed 3 days ago

Pepe-Marquez commented 3 days ago

Summary by Sourcery

Add a scatter plot feature to the perovskite ions app and enhance the documentation with new guides and acknowledgments. Refactor widget layout configuration for better readability and update tests to accommodate changes.

New Features:

Enhancements:

Documentation:

Tests:

sourcery-ai[bot] commented 3 days ago

Reviewer's Guide by Sourcery

This PR adds a scatter plot widget to the perovskite ions app and reorganizes the documentation structure. The scatter plot visualizes the relationship between A cation molar mass and number of atoms, with structural type as a color marker. The documentation changes include improved organization, new how-to guides, and additional resources.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a new scatter plot widget to visualize perovskite ion relationships
  • Implemented scatter plot with A cation molar mass vs number of atoms
  • Added color coding based on structural type
  • Configured responsive layout settings for different screen sizes
src/perovskite_solar_cell_database/apps/perovskite_ions_app.py
Restructured and enhanced documentation
  • Added new how-to guides for ion-related operations
  • Reorganized navigation structure
  • Added EU funding and project logos
  • Updated installation instructions
  • Improved homepage content organization
docs/index.md
mkdocs.yml
docs/how_to/install_this_plugin.md
docs/how_to/create_a_perovskite_composition.md
docs/how_to/add_a_new_ion.md
docs/how_to/export_a_cation_structure.md
docs/how_to/search_for_ions.md
docs/tutorial/sharing_a_perovskite_composition.md

Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).