ukaea / ukaea/PROCESS

User friendly guide to running PROCESS

Open
#2,934 0 comments 1 reaction 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

As requested on #1820, a more user friendly guide to running PROCESS (best practises, how to interpret OUT.DAT, etc) should be created. This perhaps includes a simple overview of models and how they interact.

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

Start by reading the request in issue #1820 and reviewing how PROCESS is run and how OUT.DAT is produced and interpreted. Define the guide's scope around best practices, output interpretation, and a simple overview of the models and their interactions. Done means a user-friendly guide covers those areas clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.