Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to support IESopt.jl v2.0.0 #16

Merged
merged 19 commits into from
Nov 19, 2024
Merged

Updates to support IESopt.jl v2.0.0 #16

merged 19 commits into from
Nov 19, 2024

Conversation

sstroemer
Copy link
Member

This pull request introduces several significant updates to the documentation and codebase for the IESopt project, focusing on configuration, updating processes, and code simplification. Key changes include the addition of new documentation pages, updates to the configuration handling, and the removal of deprecated functionalities.

Documentation Updates:

  • Added a new page docs/pages/dev/updating.md to provide information about updating the project between specific versions, including breaking changes and new features in version 2.0.0.
  • Introduced a configuration.md file in the docs/pages/manual/python/ directory, detailing how to configure the project using environment variables and .env files.
  • Updated the table of contents in docs/index.md to include new documentation pages [1] [2].

Configuration Handling:

  • Implemented a new Config class in src/iesopt/config.py to manage configuration options using environment variables and .env files.
  • Updated pyproject.toml to include python-dotenv as a dependency for handling environment variables.

Codebase Simplification:

  • Removed verbosity parameter from the run function in src/iesopt/iesopt.py (because this is now part of the top-level config) [1] [2] [3].
  • Replaced deprecated IESoptLib references with IESopt.Assets in src/iesopt/iesopt.py [1] [2].

Version Updates:

  • Updated the project version to 2.0.0 in pyproject.toml to reflect the new major release.

Removal of Deprecated Functionalities:

  • Removed the log_welcome_msg function and related code from src/iesopt/julia/general.py.

These changes collectively enhance the project's documentation, streamline configuration management, and simplify the codebase by removing outdated components.

@codecov-commenter
Copy link

codecov-commenter commented Nov 19, 2024

Codecov Report

Attention: Patch coverage is 70.58824% with 40 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/iesopt/julia/setup.py 62.31% 26 Missing ⚠️
src/iesopt/model.py 60.00% 4 Missing ⚠️
src/iesopt/config.py 89.28% 3 Missing ⚠️
src/iesopt/julia/util.py 66.66% 3 Missing ⚠️
src/iesopt/results.py 57.14% 3 Missing ⚠️
src/iesopt/julia/general.py 88.88% 1 Missing ⚠️
Files with missing lines Coverage Δ
src/iesopt/iesopt.py 94.87% <100.00%> (-0.13%) ⬇️
src/iesopt/julia/general.py 92.00% <88.88%> (-3.24%) ⬇️
src/iesopt/config.py 89.28% <89.28%> (ø)
src/iesopt/julia/util.py 74.19% <66.66%> (+26.36%) ⬆️
src/iesopt/results.py 46.82% <57.14%> (+19.40%) ⬆️
src/iesopt/model.py 49.27% <60.00%> (+4.16%) ⬆️
src/iesopt/julia/setup.py 65.78% <62.31%> (-27.07%) ⬇️

🚨 Try these New Features:

@sstroemer sstroemer merged commit 5901216 into main Nov 19, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants