Skip to content

cmipcite#

Entrypoint for the command-line interface

Usage:

$ cmipcite [OPTIONS] COMMAND [ARGS]...

Options:

  • --version: Print the version number and exit
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • get: Generate citations from CMIP files or...

cmipcite get#

Generate citations from CMIP files or tracking IDs or PIDs

Usage:

$ cmipcite get [OPTIONS] IN_VALUES...

Arguments:

  • IN_VALUES...: Tracking IDs, PIDs or file paths for which to generate citations. [required]

Options:

  • --out-path PATH: Path in which to write the output. If not provided, it is printed.
  • --format [bibtex|text]: Format in which to retrieve the citations. [default: text]
  • --author-list-style [short|long]: Whether the author list should be long (all names) or short (et al.). [default: long]
  • --doi-granularity [experiment|model]: Desired granularity of the retrieved DOIs. [default: model]
  • --multi-dataset-handling [latest|first]: Strategy to use when a given ID or file belongs to multiple datasets.
  • --handle-server-url TEXT: URL of the server to use for handling tracking IDs i.e. handles [default: http://hdl.handle.net/]
  • --help: Show this message and exit.