Add source directory, rename groupContribution class to fuel - #21
Merged
Conversation
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR implements a major reorganization of the FuelLib codebase by creating a source directory and renaming the main class from groupContribution to fuel. The changes include centralized path management and updates to all affected files.
- Introduces a
sourcedirectory containing the main source code files - Renames the
groupContributionclass tofuelfor clearer semantics - Implements centralized path management through a new
paths.pyfile
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| source/FuelLib.py | Renamed class from groupContribution to fuel and updated path handling |
| source/Export4Pele.py | Updated class references and improved export functionality with metadata |
| source/Export4Converge.py | Updated class references and improved export functionality |
| paths.py | New centralized path management file |
| tutorials/*.py | Updated import paths and class references |
| tests/*.py | Updated import paths and class references |
| docs/*.rst | Updated documentation to reflect class rename and reorganization |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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 includes some breaking changes and reorganization of files (last time I promise).
Breaking changes:
sourcedirectory. This is necessary for organization as we build toward including multi-component evaporation models within FuelLib.FuelLib.py, thegroupContributionclass was renamedfuel. This was motivated by the fact that the class is much more than GCM. It provides a characterization of the fuel. All instances ofgroupContributionmust now be called using the following:Path Management
FuelLib/paths.pythat creates variables for the various paths. Any file that importspathsautomatically imports thesourcedirectory.