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

Add a note on charge generation during CLI workflows #1117

Merged
merged 8 commits into from
Feb 12, 2025
Merged

Conversation

jthorton
Copy link
Collaborator

@jthorton jthorton commented Feb 6, 2025

This PR adds a note to inform users of the CLI that we are now generating charges when planning networks. I have also added a link to the new tutorial in example notebooks which should be merged first OpenFreeEnergy/ExampleNotebooks#187

Checklist

  • Added a news entry

Developers certificate of origin

Copy link

codecov bot commented Feb 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.87%. Comparing base (f7b11d4) to head (54a4d2b).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1117      +/-   ##
==========================================
- Coverage   93.51%   91.87%   -1.65%     
==========================================
  Files         142      142              
  Lines       10608    10608              
==========================================
- Hits         9920     9746     -174     
- Misses        688      862     +174     
Flag Coverage Δ
fast-tests 91.87% <ø> (?)
slow-tests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/tutorials/index.rst Outdated Show resolved Hide resolved
docs/guide/introduction.rst Outdated Show resolved Hide resolved
@atravitz atravitz added this to the v1.3.0 milestone Feb 10, 2025
@jthorton jthorton linked an issue Feb 11, 2025 that may be closed by this pull request
@atravitz atravitz self-requested a review February 11, 2025 16:14
Copy link
Contributor

@atravitz atravitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just two typos, then lgtm!

docs/guide/introduction.rst Outdated Show resolved Hide resolved
docs/tutorials/index.rst Outdated Show resolved Hide resolved
Copy link

No API break detected ✅

@jthorton jthorton enabled auto-merge February 12, 2025 10:50
@jthorton jthorton merged commit d3474c8 into main Feb 12, 2025
12 checks passed
@jthorton jthorton deleted the charge_warning branch February 12, 2025 11:14
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.

partial charge CLI tutorial
3 participants