4141 remove f90 references from both docstrings and docs by chris-ashe · Pull Request #4283 · ukaea/PROCESS

chris-ashe · 2026-06-03T08:34:51Z

Description

Checklist

I confirm that I have completed the following checks:

My changes follow the PROCESS style guide
I have justified any large differences in the regression tests caused by this pull request in the comments.
I have added new tests where appropriate for the changes I have made.
If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
If I have made documentation changes, I have checked they render correctly.
I have added documentation for my change, if appropriate.

chris-ashe · 2026-06-03T08:35:45Z

@timothy-nunn Tagging you here is there is lots of Fortran talked about in the vmcon stuff and not sure if it should be touched

Copilot

Pull request overview

This pull request updates the codebase documentation and inline docstrings/comments to remove or replace legacy references to Fortran (.f90) with Python (.py), aligning wording with the current Python-centric implementation.

Changes:

Replace .f90 references in documentation pages with .py equivalents (solver, physics, stellarator, costs, development docs).
Remove/adjust Fortran-specific phrasing in docstrings and comments across models, core solver/input, and tests.
Minor cleanup of legacy explanatory comments tied to the former Fortran implementation.

Reviewed changes

Copilot reviewed 35 out of 35 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
tracking/tracking_data.py	Removes Fortran-specific guidance from tracking-related docstrings/comments.
tests/unit/models/test_pfcoil.py	Updates test docstrings/comments to remove “Fortran module variables” phrasing.
tests/unit/models/test_divertor.py	Updates module-level test docstring from `.f90` to `.py`.
tests/unit/models/test_availability.py	Removes Fortran-specific comments around test isolation.
tests/unit/models/physics/test_plasma_geom.py	Updates module-level test docstring from `.f90` to `.py`.
tests/unit/models/physics/test_physics.py	Updates module-level test docstring from `.f90` to `.py`.
tests/unit/models/physics/test_impurity_radiation.py	Fixes docstring referencing `.f90.py` to `.py`.
tests/integration/test_vmcon.py	Updates fixture docstring to remove Fortran phrasing.
process/models/tfcoil/superconducting.py	Removes legacy Fortran behavior notes from comments.
process/models/tfcoil/base.py	Updates docstrings/comments to remove Fortran references.
process/models/stellarator/coils/coils.py	Removes comment referencing `.f90` provenance for constants.
process/models/power.py	Removes “only used in costs.f90” note from comment.
process/models/physics/physics.py	Removes Fortran-loop commentary and updates output-related docstring text.
process/models/pfcoil.py	Updates model init docstrings and removes Fortran-specific TODO/commentary.
process/models/blankets/hcpb.py	Removes “only used by old routines in … .f90” comment.
process/models/blankets/dcll.py	Updates `.f90` reference in docstring line to `.py`.
process/main.py	Rewrites top-level module docstring away from Fortran runtime description; updates various method docstrings.
process/data_structure/tfcoil_variables.py	Updates variable docstring references from `initial.f90` to `initial.py`.
process/data_structure/numerics.py	Removes Fortran-specific comments about iteration variables and dictionary generation.
process/core/solver/solver_handler.py	Removes Fortran-specific initialization/output comments and adjusts docstring wording.
process/core/solver/iteration_variables.py	Removes Fortran-specific doc/comment text in iteration variable metadata and loading logic.
process/core/scan.py	Updates class docstring to remove “Fortran scan module” phrasing.
process/core/process_output.py	Removes a “remove when Fortran is gone” TODO comment.
process/core/output.py	Removes Fortran-specific parameter description in docstring.
process/core/io/vary_run/tools.py	Removes Fortran numbering conversion comment.
process/core/io/in_dat/base.py	Removes large block comments describing legacy Fortran init/indexing issues.
process/core/io/data_structure_dicts.py	Updates docstrings to reference `input.py` rather than `input.f90`.
process/core/input.py	Updates docstrings and error messages to remove “Fortran module” wording.
process/core/caller.py	Removes Fortran-vs-Python distinction in caller docstring.
documentation/source/solver/solver-guide.md	Updates solver guide reference from `evaluators.f90` to `evaluators.py`.
documentation/source/physics-models/fusion_reactions/plasma_reactions.md	Updates `constants.f90` references to `constants.py`.
documentation/source/fusion-devices/stellarator.md	Updates stellarator source reference from `stellarator.f90` to `stellarator.py`.
documentation/source/development/standards.md	Updates standards references/examples from Fortran to Python.
documentation/source/development/add-vars.md	Updates variable/iteration-variable add instructions from `.f90` to `.py` and replaces examples.
documentation/source/cost-models/cost-models.md	Updates costs model source reference from `costs.f90` to `costs.py`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

        """Subroutine to output the plasma physics information
-        self.outfile : input integer : Fortran output unit identifier
+        self.outfile : file to write to
        This routine writes the plasma physics information
        to a file, in a tidy format.
        """


    models : process.main.Models
        physics and engineering model objects
    _outfile : int
-        Fortran output unit identifier

    """


codecov-commenter · 2026-06-03T08:57:55Z

Codecov Report

❌ Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 48.79%. Comparing base (89e1ebe) to head (f087387).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
process/core/input.py	50.00%	1 Missing ⚠️
process/models/stellarator/coils/coils.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4283   +/-   ##
=======================================
  Coverage   48.79%   48.79%           
=======================================
  Files         151      151           
  Lines       29383    29383           
=======================================
  Hits        14337    14337           
  Misses      15046    15046

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

clmould

Just a few things from me

Can this comment be deleted:

Can this comment also be deleted please:

clmould · 2026-06-03T16:45:23Z

    if isinstance(value, np.ndarray):
        value = value.item()
    if isinstance(value, bytes):
-        # TODO: remove when Fortran is gone


Does the line below need removing, or has this TODO already been done?

timothy-nunn · 2026-06-05T09:58:52Z

@chris-ashe I'm going to pass this PR off to Clair while I am on AL.

timothy-nunn · 2026-06-05T12:27:38Z

@timothy-nunn Tagging you here is there is lots of Fortran talked about in the vmcon stuff and not sure if it should be touched

Yep fine to leave the VMCON stuff. This should probably be its own issue as a lot of this docs has been moved to the VMCON repository

…e files

…ns to Python

…ples

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

… mapping descriptions

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

…descriptions

clmould

Majority are suggested changes, then a couple qs and also checking some things with @timothy-nunn where I am uncertain

clmould · 2026-06-19T14:22:41Z

            continue

        # matches (variable name, array index, value)
-        # NOTE: array index is Fortran-based hence starts at 1.


@timothy-nunn I am unsure if this comment regarding indexing is still required?

clmould · 2026-06-19T14:24:36Z

    if isinstance(value, np.ndarray):
        value = value.item()
    if isinstance(value, bytes):
-        # TODO: remove when Fortran is gone


@timothy-nunn can this be removed? I am unsure if it is referring to this if statement or something else that was removed already ?

clmould · 2026-06-19T14:25:43Z

-        # Initialise iteration variables and bounds in Python: relies on Fortran
-        # iteration variables being defined above
-        # Trim maximum size arrays down to actually used size
+        # Initialise solver variables from numerics module


Suggested change

# Initialise solver variables from numerics module

# Initialise iteration variables from numerics module

# Trim maximum size arrays down to actually used size

Think it's worth explaining the slicing

clmould · 2026-06-19T15:39:00Z

-This file, process.py, is now analogous to process.f90, which contains the
-Fortran "program" statement. This Python module effectively acts as the Fortran
-"program".
+"""Run `PROCESS` by calling into the Python module.


should it say 'Python module' or 'Python modules' ?

clmould · 2026-06-19T15:42:17Z

    n_pf_coil_groups = 4
    n_pf_coils_in_group = np.array([1, 1, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0])

-    # This 2D array argument discovered via gdb prints as a 1D array, therefore


Think it's worth keeping the first sentence here to explain the reshaping, but the 2nd can be deleted

clmould · 2026-06-19T15:42:39Z

@timothy-nunn

clmould · 2026-06-19T15:45:44Z

+Refrain from declaring or typing known numerical constants directly in the code. Instead call the value from `constants.py`
 If the constants doesn't exist then add it with a source link and uncertainty value.


Suggested change

Refrain from declaring or typing known numerical constants directly in the code. Instead call the value from `constants.py`

If the constants doesn't exist then add it with a source link and uncertainty value.

Refrain from declaring or typing known numerical constants directly in the code. Instead call the value from `constants.py`.

If the constant doesn't exist then add it with a source link.

The constants in constants.py just seem to have a source link?

clmould · 2026-06-19T15:49:24Z

@@ -100,7 +97,5 @@ def output(self):
        Objective function value, solution vector and constraints vector.
        """
        self.data.numerics.norm_objf = self.solver.objf


Suggested change

self.data.numerics.norm_objf = self.solver.objf

self.data.numerics.norm_objf = self.solver.objf

# Slicing required to trim maximum sized arrays down to actually used size

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

Copilot AI review requested due to automatic review settings June 3, 2026 08:34

chris-ashe requested a review from a team as a code owner June 3, 2026 08:34

chris-ashe added the Documentation Improvements or additions to documentation label Jun 3, 2026

chris-ashe linked an issue Jun 3, 2026 that may be closed by this pull request

Remove F90 references from both docstrings and docs #4141

Open

chris-ashe requested a review from timothy-nunn June 3, 2026 08:35

Copilot started reviewing on behalf of chris-ashe June 3, 2026 08:35 View session

Copilot AI reviewed Jun 3, 2026

View reviewed changes

timothy-nunn self-assigned this Jun 3, 2026

clmould self-requested a review June 3, 2026 13:54

clmould reviewed Jun 4, 2026

View reviewed changes

timothy-nunn assigned clmould and unassigned timothy-nunn Jun 5, 2026

chris-ashe and others added 7 commits June 19, 2026 12:03

Remove Fortran references from docstrings and comments across multipl…

9d9c977

…e files

Remove Fortran references from documentation and update file extensio…

ee5a8f6

…ns to Python

Remove Fortran references from documentation and update variable exam…

f8898c7

…ples

Apply suggestions from code review

c017e76

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Refactor docstrings to remove Fortran references and clarify variable…

b1c5dfc

… mapping descriptions

Update documentation/source/development/add-vars.md

14e1da0

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

Remove Fortran references from documentation, comments, and variable …

bdd254b

…descriptions

chris-ashe force-pushed the 4141-remove-f90-references-from-both-docstrings-and-docs branch from 3d24903 to bdd254b Compare June 19, 2026 11:05

Post rebase fixes

0b70485

clmould requested changes Jun 19, 2026

View reviewed changes

chris-ashe and others added 2 commits June 22, 2026 09:53

Update process/models/stellarator/stellarator.py

f367a6c

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

Update process/core/output.py

f087387

Co-authored-by: clmould <86794332+clmould@users.noreply.github.com>

	# Initialise solver variables from numerics module
	# Initialise iteration variables from numerics module
	# Trim maximum size arrays down to actually used size

		Refrain from declaring or typing known numerical constants directly in the code. Instead call the value from `constants.py`
		If the constants doesn't exist then add it with a source link and uncertainty value.

	self.data.numerics.norm_objf = self.solver.objf
	self.data.numerics.norm_objf = self.solver.objf
	# Slicing required to trim maximum sized arrays down to actually used size

Conversation

chris-ashe commented Jun 3, 2026

Description

Checklist

Uh oh!

chris-ashe commented Jun 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

clmould left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

timothy-nunn commented Jun 5, 2026

Uh oh!

timothy-nunn commented Jun 5, 2026

Uh oh!

clmould left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

clmould Jun 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov-commenter commented Jun 3, 2026 •

edited

Loading

clmould Jun 19, 2026 •

edited

Loading