Explain how to save data with a specific STASH code
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start with the “Phenomenon identification” section of the UM files loading tech paper and review the STASH class documentation. Document how to set a STASH object when saving PP output, add the cross-link, and correct the misleading highlighted note about standard_name translation. Verify that the examples accurately describe the current saving behavior.
Written by the indexing model from the issue text.
Description
📚 Documentation
As I said in an internal support discussion ...
You can set a STASH attribute on a cube to control how it is recorded in PP output.
Like this :
import iris.fileformats.pp as ipp
cube.attributes['STASH'] = ipp.STASH(model=1, section2, item=34)
or
cube.attributes['STASH'] = ipp.STASH.from_msi('m01s02i034')
This is briefly mentioned here : https://scitools-iris.readthedocs.io/en/latest/techpapers/um_files_loading.html?highlight=STASH#phenomenon-identification
But I see that is incomplete + doesn't explain exactly what you need to do to control the saving.
It is currently required that the attribure must be a STASH object
(we could fix that + allow an 'msi' string ?).
The solution should be added to the above tech-paper section.
It should also cross-link to the docs for the STASH class.
ALSO : the highlighted note-box in the above section is highly misleading
On saving data, no attempt is made to translate a cube standard_name into a STASH code, but ...
That really needs fixing too.
- Dominant language
- Python
- Stars
- 724
- Forks
- 317
- Avg merge
- 3d 20h
- Merged PRs (30d)
- 9
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SciTools/iris
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bancolombia/sentinel#23 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100