PmagPy / PmagPy/PmagPy-docs

update "Quickstart with PmagPy notebooks" in PmagPy_install.md

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

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
5
Forks
4
PR merge metrics
No merged PRs in 30d

Description

The current commands assume that the notebooks are in the main PmagPy repo which we plan to change.

Contributor guide

No contributing guide indexed for this repository

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

Open PmagPy_install.md and locate the “Quickstart with PmagPy notebooks” section. Review the current commands and confirm where the notebooks will live after the planned repository change; update the commands to use that location. Done means the quickstart no longer assumes notebooks are in the main PmagPy repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.