Skip to content

Commit

Permalink
Ready to publish v1.5.2
Browse files Browse the repository at this point in the history
  • Loading branch information
aaghamohammadi committed Dec 23, 2023
1 parent 61b87c0 commit 483db5a
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
39 changes: 39 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,45 @@
Changelog
=========

Version 1.5.2
-------------

Release date: 2023-12-23

Changed
^^^^^^^

- Refactoring in various modules (``plotter.py``, ``report.py``, ``tests/test_pysolorie.py``, etc.) to improve code clarity and reduce the complexity.
- Renamed "optimal orientation" to "optimal tilt angle" in the README, documentation, and examples to more accurately reflect solar panel positioning.
- Updated and clarified solar irradiance discussion in the paper draft, along with audience benefits, terminology, and code usage in the README and documentation.
- Improved various code samples across the documentation for enhanced clarity and consistency.

Fixed
^^^^^

- Fixed the incorrect setting of logger instances within several classes and refactored the decorating function to correctly set the logger attribute.
- Resolved mypy type checking errors by adding type ignore comments where necessary.


Testing
^^^^^^^

- Extensive refactoring of test cases, with tests being moved to newly named files according to their respective functionalities.
- Addition of test cases for new refactorings and exception handling enhancements to ensure code reliability and correctness.

Documentation
^^^^^^^^^^^^^

- Amended the Sphinx configuration with the ``sphinx-copybutton`` extension and updated the packages list to include the extension.
- Corrected and improved the structure of documentation files to enhance user understanding and readability.

Miscellaneous
^^^^^^^^^^^^^

- Simplified GitHub issue templates to make them more accessible and concise for users.
- Refinement of content descriptions, departmental affiliations for authors, and enhancement of figure captions in the paper draft.


Version 1.5.1
-------------

Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = pysolorie
version = 1.5.1
version = 1.5.2
description = Orientation Analysis of Solar Panel
long_description = file: README.md
long_description_content_type = text/markdown
Expand Down

0 comments on commit 483db5a

Please sign in to comment.