Refactor PLEIADES repo following new PEP8 standards #23
Conversation
This file contains 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
…n and execution logic
…nc methods in SammyRunner; add pytest fixtures for testing
KedoKudo
changed the title
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 PR is preparing for the v2.0 of PLEIADES via refactoring.
Both the main structure and API are changed.
V2.0 is still a work in progress, please use main branch until 2.0 is ready.
This pull request includes several significant changes aimed at improving the test automation, code quality, and documentation of the project. The most important changes are the addition of a GitHub Actions workflow for running unittests, updates to the pre-commit configuration, and comprehensive documentation for the PLEIADES architecture and refactoring plans. Additionally, there are removals of outdated configuration files.
Test Automation:
.github/workflows/unittest.yaml: Added a GitHub Actions workflow to run unittests on pull requests and pushes to the main branch. This includes setting up Python, installing dependencies with Poetry, and running tests with pytest.Code Quality:
.pre-commit-config.yaml: Updated the pre-commit configuration to exclude new directories (tests/data/.*andlegacy/.*) from certain hooks, ensuring that only relevant files are checked.Documentation:
docs/development/architecture_v1.md: Added detailed documentation for the PLEIADES v1 architecture, including system architecture, module details, an example workflow, and opportunities for enhancement.docs/development/architecture_v2.md: Added a refactoring design document for PLEIADES, outlining the goals, proposed architecture, and refactoring guidelines to address current challenges such as tight coupling and inconsistent error handling.Configuration Cleanup:
examples/configFiles/nat_europium.ini: Removed an outdated configuration file for natural europium analysis.examples/configFiles/simTransmissionConfig.ini: Removed an outdated simulation configuration file for transmission analysis.examples/configFiles/uranium.ini: Removed an outdated configuration file for uranium analysis.