Write some documentation of using NDCube with custom data

Open
#526 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the existing NDCube documentation and examples to identify where current usage assumes data and a WCS. Add examples covering a pixel-to-world transform converted to a gWCS, coordinate arrays converted to a WCS, and a custom APE 14 WCS class. Done means each of the three custom-data workflows is documented clearly enough to follow without pre-existing data or WCS.

Written by the indexing model from the issue text.

Description

Documentation Feature Request help wanted
Describe the feature

Currently our documentation largely assumes you have data and a WCS already, we should write some docs / examples not making this assumption.

Things I can think of are:

  • I have a pixel->world transform function how do I make it into a gWCS
  • I have some coordinate arrays how do I make them it into a WCS.
  • How do I write my own custom APE 14 WCS class.
Proposed solution

No response

Dominant language
Python
Stars
49
Forks
56
Avg merge
5h 54m
Merged PRs (30d)
9

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.

More from sunpy/ndcube

All issues in sunpy/ndcube

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.