Ready to release v1.5.2 #14
Merged
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
- Remove unnecessary metadata from bug report and feature request templates - Keep only essential fields in the templates to make them more concise
- Added an "Example Usage" section to the README. This section includes a detailed example of how to use the `pysolorie` package to plot the optimal orientation of a solar panel for each day of the year for a specific location (Tehran in this case). - The example also demonstrates the use of the `IrradiationCalculator` and `Plotter` classes from the `pysolorie` package. - Included a sample output figure in the README to illustrate the results of the example code.
This commit refines the discussion on solar irradiation, including the assumptions made and the factors that may affect the amount of solar energy received on Earth. It also moves the paragraph about the benefits of `pysolorie` to a more appropriate location in the text.
- Specify departmental affiliations for authors - Clarify that the package is for "fixed flat solar panels" - Update figure caption to better describe the image - Refine feature descriptions to be more precise
This commit adds the sphinx-copybutton extension to the list of extensions in the Sphinx configuration file (conf.py). This extension adds a "copy" button to each code block in the Sphinx documentation, making it easier for users to copy code examples. The sphinx-copybutton package is also added to the list of dependencies in setup.cfg.
Update README, documentation, and examples to reflect accurate terminology and code use - Updated terminology from 'optimal orientation' to 'optimal tilt angle' to more accurately reflect solar panel positioning. - Enhanced descriptions of Hottel's Model application for clear-sky condition assessment. - Added installation instructions for the library in README.md. - Expanded the Getting Started documentation to include examples of calculating total direct irradiation and plotting. - Included sphinx-copybutton in documentation dependencies for convenience. - Improved code samples across documentation for better clarity and consistency. - Corrected various instances where method descriptions were not matching their actual functionality. - Miscellaneous copy edits and improvements to the structure of documentation files. ```
- Removed the import of InvalidClimateTypeError from pysolorie/__init__.py. - Removed InvalidClimateTypeError from the __all__ list in pysolorie/__init__.py. - Added exceptions to the import list in tests/test_pysolorie.py. - Updated the pytest.raises calls in tests/test_pysolorie.py to use exceptions.InvalidClimateTypeError.
- Created a new file tests/test_model.py. - Moved the HottelModel tests from tests/test_pysolorie.py to tests/test_model.py. - Removed the import of HottelModel from tests/test_pysolorie.py. - Removed the HottelModel tests from tests/test_pysolorie.py.
- Created a new file tests/test_sun_position.py. - Moved the SunPosition tests from tests/test_pysolorie.py to tests/test_sun_position.py. - Removed the SunPosition tests from tests/test_pysolorie.py.
- Created a new file tests/test_irradiance.py. - Moved the SolarIrradiance tests from tests/test_pysolorie.py to tests/test_irradiance.py. - Removed the SolarIrradiance tests from tests/test_pysolorie.py.
- Created a new file tests/test_observer.py. - Moved the Observer tests from tests/test_pysolorie.py to tests/test_observer.py. - Removed the Observer tests from tests/test_pysolorie.py.
- Created a new file tests/test_atmospheric_transmission.py. - Moved the AtmosphericTransmission tests from tests/test_pysolorie.py to tests/test_atmospheric_transmission.py. - Removed the AtmosphericTransmission tests from tests/test_pysolorie.py.
- Created a new file tests/test_numerical_integration.py. - Moved the IrradiationCalculator tests from tests/test_pysolorie.py to tests/test_numerical_integration.py. - Removed the IrradiationCalculator tests from tests/test_pysolorie.py.
- Created a new file tests/test_report_generator.py. - Moved the ReportGenerator tests from tests/test_pysolorie.py to tests/test_report_generator.py. - Removed the ReportGenerator tests from tests/test_pysolorie.py.
- Fixed the `logger_decorator` in `logger.py` to set the logger on `self` instead of a local variable. - Removed unnecessary `import logging` statements in `plotter.py` and `report.py`. - Added the `logger_decorator` to the `_calculate_optimal_orientations` method in `plotter.py` and the `_calculate_optimal_orientation_and_irradiation` method in `report.py`. - Replaced the local `logger` instances in `plotter.py` and `report.py` with `self.logger`. - Added `# type: ignore` comments to suppress mypy errors related to the dynamic `logger` attribute.
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #14 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 11 11
Lines 277 274 -3
Branches 13 13
=========================================
- Hits 277 274 -3 ☔ View full report in Codecov by Sentry. |
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.
No description provided.