Update documentation for constraints to remove f-values#4112
Open
timothy-nunn wants to merge 2 commits intomainfrom
Open
Update documentation for constraints to remove f-values#4112timothy-nunn wants to merge 2 commits intomainfrom
timothy-nunn wants to merge 2 commits intomainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4112 +/- ##
=======================================
Coverage 47.18% 47.19%
=======================================
Files 138 138
Lines 29280 29275 -5
=======================================
Hits 13817 13817
+ Misses 15463 15458 -5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
timothy-nunn
force-pushed
the
4051-update-constraint-documentation
branch
2 times, most recently
from
a8efd99 to
b5a9745
Compare
timothy-nunn
force-pushed
the
4051-update-constraint-documentation
branch
from
b5a9745 to
9e5f240
Compare
je-cook
reviewed
Feb 27, 2026
Co-authored-by: je-cook <81617086+je-cook@users.noreply.github.com>
chris-ashe
requested changes
Mar 20, 2026
| ## Add a constraint equation | ||
|
|
||
| Constraint equations are added to *PROCESS* in the `process/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/optimisation/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.
This is `process/core/solver/ now
Collaborator
There was a problem hiding this comment.
Also noticed that "Add an input" is still showing the fortran
|
|
||
| PROCESS permits a large number of constraint equations, all of which are formulated | ||
| in the source file `constraint equations.f90`. | ||
| in the source file `process/core/optimisation/constraints.py`. |
Collaborator
There was a problem hiding this comment.
Same as above with file path
| Any computer program naturally contains many equations. The built-in equation | ||
| solvers within PROCESS act on a special class, known as constraint equations, | ||
| all of which are formulated in the source file `constraint equations.f90`. These | ||
| all of which are formulated in the source file `process/core/optimisation/constraints.py`. These |
| ``` | ||
|
|
||
| Here each `icc=n` statement tells PROCESS to activate a constraint with the name `n`. A list of the constraints and | ||
| their corresponding names can be found [here](../../source/reference/process/data_structure/numerics/#process.data_structure.numerics.lablcc). |
Collaborator
There was a problem hiding this comment.
The link seems to take me to an empty page
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.
Closes #3935
Closes #4051