NCAS-CMS / NCAS-CMS/cf-plot

Create and add 'Cheat Sheet' to extend cf-python one

Open
#28 0 comments 0 reactions 1 assignee View on GitHub

@sadielbartholomew is already working on this.

Since Feb 29, 2024.

docs
Dominant language
Python
Stars
21
Forks
11
Avg merge
7h 11m
Merged PRs (30d)
1

Description

It would be nice to have a Cheat Sheet document to summarise important function calls and outputs and in general the utility of cf-plot.

We currently have a fantastic one for cf-python, and that has the benefit of working both in online format and as a printed document. I suggest we design our Cheat sheet' so that it extends the cf-python one to showcase the plotting capability with cf-plot after set up with cf-python as per the cf-python Cheat Sheet. If we can create an identical page format, then the cf-plot cheat sheet can also be printed out and sit alongside the cf-python one to form an overall cf* NCAS Data Tools Cheat Sheet that is twice the size but the individual documents can also work standalone.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.