Documentation: add an 'Iris to cf-python conversion' guide
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 150
- Forks
- 23
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 2
Description
During a recent NCAS-CMS update seminar for NCAS@Reading, someone (name available on request though I will keep it anonymous here!) suggested that it would very useful to have a (direct quote) "guide to translate Iris into cf-python" to make it easier for those who use Iris to get started using cf-python as an alternative.
We also know of people CMS who are in the process of making such a migration from Iris to cf-python for relevant parts of some of their code and/or projects. So we know this is a task people are doing, and providing dedicated guidance on the process would indeed be a helpful resource, in my opinion.
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.
Research direction
No file, test, or documentation entry point is identified in the issue. Start by reviewing the existing Iris and cf-python workflows and determine the migration topics the guide must cover. Done means a committed guide that helps Iris users begin using cf-python as an alternative.
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