ukaea / ukaea/PROCESS

Update installation docs for installing python

Open
#3,686 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation
Dominant language
Python
Stars
71
Forks
27
Avg merge
2d 18h
Merged PRs (30d)
33

Description

We should probably recommend using uv for Python installation in our docs.

Make it clear that only Python 3.10 and 3.11 are supported whilst we have Fortran in the code.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate and read the installation documentation, then identify the section covering Python setup. Update it to recommend uv and clearly state that Python 3.10 and 3.11 are the supported versions while Fortran remains part of the code; the documentation should make both installation guidance and version limits unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
fortran, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.