Merged
Conversation
…uery (not full data).
…d improved documentation
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.
This pull request introduces several improvements and updates across the codebase, primarily focused on licensing, documentation, testing, and database utilities. The most notable changes include the adoption of the BSD 3-Clause License, enhancements to the release and documentation workflow, expanded database testing, and updates to metadata and badges for clarity and compliance.
Licensing and Metadata Updates:
uq_physicell/LICENSE.md) and updated the license reference inpyproject.tomlto point to this file, replacing the previous MIT license reference. [1] [2]README.mdto reflect the new release date and added a license badge for visibility.Release and Documentation Workflow Improvements:
pyproject.tomlto clarify the steps for versioning, documentation updates, and PyPI publishing, including explicit reminders not to create a new version if there are no changes in the core module.Testing and Database Utilities:
tests/test_ma_database.py, covering database creation, insertion, and modular load functions for improved reliability and coverage.uq_physicell/database/__init__.pyto import and expose key database modules and utility functions, enabling convenient dot notation access and simplifying usage.Release Versioning and Documentation:
1.2.2to1.2.3inuq_physicell/VERSION.pyand updated documentation references to the new release version. [1] [2]CI/CD Workflow Adjustment:
.github/workflows/test-examples.yml)These changes collectively improve the project's compliance, maintainability, and reliability, while making the release and documentation process clearer for contributors.