Update add-vars.md#4332
Open
timothy-nunn wants to merge 9 commits into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4332 +/- ##
==========================================
+ Coverage 48.86% 48.87% +0.01%
==========================================
Files 151 151
Lines 29417 29426 +9
==========================================
+ Hits 14374 14383 +9
Misses 15043 15043 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Collaborator
Author
|
Requesting a couple of reviews to ensure these docs make sense and are sufficiently detailed |
timothy-nunn
force-pushed
the
3664-update-add-varsmd
branch
from
0aba1cf to
d1dd370
Compare
clmould
requested changes
Jun 18, 2026
chris-ashe
requested changes
Jun 19, 2026
chris-ashe
reviewed
Jul 9, 2026
| ``` | ||
| minmax = 20 | ||
| ``` | ||
| Remember, setting `minmax = -20` would minimise instead of maximise our new variable. |
Collaborator
There was a problem hiding this comment.
Would be good the specify here that this is the case as it is the value of the second derivative?
clmould
requested changes
Jul 9, 2026
| my_new_blanket_variable = 1.0 | ||
| ``` | ||
|
|
||
| ----------------- |
Collaborator
There was a problem hiding this comment.
Do we need a bit here about how the value of an input variable is unchanged throughout a run ?
Collaborator
Author
There was a problem hiding this comment.
This point is made at least twice in the document, I think that should be enough
| ## Add a constraint equation | ||
|
|
||
| Constraint equations are added to *PROCESS* in the `process/core/solver/constraints.py` file. They are registered with the `ConstraintManager` whenever the application is run. Each equation has a unique name that is currently an integer, however upgrades to the input file format in the future will allow arbitrary hashable constraint names. | ||
| Constraint equations are added to PROCESS in the `process/core/solver/constraints.py` file. They are registered with the `ConstraintManager` whenever the application is run. Each equation has a unique name that is currently an integer, however upgrades to the input file format in the future will allow arbitrary hashable constraint names. |
Collaborator
There was a problem hiding this comment.
Will updates to the input file format mean changes for more things in this page other than just constraints? If so, probably worth a general note at the start of this page? Might not though, just thought I'd ask!
Collaborator
Author
There was a problem hiding this comment.
Tbh that information is probably not necessary and I will remove it
Co-authored-by: clmould <86794332+clmould@users.noreply.github.com> Co-authored-by: Christopher Ashe <91618944+chris-ashe@users.noreply.github.com>
Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>
timothy-nunn
force-pushed
the
3664-update-add-varsmd
branch
from
a18ef77 to
3af3782
Compare
clmould
requested changes
Jul 9, 2026
Comment on lines
173
to
+177
| The arguments to the `register_constraint` function are: | ||
|
|
||
| - Name (again, currently an integer) | ||
| - Unit (for output reporting purposes) | ||
| - Symbol (e.g. =, >=, <=. Again, for output reporting purposes) | ||
| - Symbol (e.g. `=`, `>=`, `<=`. Again, for output reporting purposes) |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Symbol (e.g. `=`, `>=`, `<=`. Again, for output reporting purposes) |
think github might've messed up my suggestion ! not sure why it added it instead of overwriting !
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
4 participants
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.
Updated the guide for adding variables, inputs, scan vars, figures of merit, and iteration vars. They needed a refresh due to changes in the Python conversion, recent data structure changes, and enumification.
I have also reduced the need for users to manually increment some variables (was not possible for the scan variables due to circular imports).