Skip to content

integrating documentation of command line functionality into docs #8

@Swanson-Hysell

Description

@Swanson-Hysell

The previous version of the introduction notebook started with describing the command line functionality. An issue with this notebook for documenting the command line is that it doesn't include the descriptions that can be found by using the -h flag. We could run each function with both the -h flag and then the example. Note that this programs have functional equivalents now that we could decide largely supersede the command line programs at some point.

This text:

PmagPy is a software package for analyzing paleomagnetic and rock magnetic data using Python. These notebooks demonstrate how to use PmagPy in a Jupyter notebook or Python script. For examples of how to use PmagPy scripts on the command line, see the static version of PmagPy_cli. If you are running this notebook locally, you can click the following link to launch PmagPy-cli.ipynb

has been simplified to:

PmagPy is a software package for analyzing paleomagnetic and rock magnetic data using Python. These notebooks demonstrate how to use PmagPy in a Jupyter notebook. These examples can be adapted into Python scripts.
to try and keep things more straight forward for a new user.

The text

For examples of how to use PmagPy scripts on the command line, see the static version of PmagPy_cli.
could be added later.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions