LinuxCommandLibrary

particle

Manage Particle IoT devices and cloud services

TLDR

Log in or create an account for the Particle CLI

$ particle setup
copy

Display a list of devices
$ particle list
copy

Create a new Particle project interactively
$ particle project create
copy

Compile a Particle project
$ particle compile [device_type] [path/to/source_code.ino]
copy

Update a device to use a specific app remotely
$ particle flash [device_name] [path/to/program.bin]
copy

Update a device to use the latest firmware via serial
$ particle flash --serial [path/to/firmware.bin]
copy

Execute a function on a device
$ particle call [device_name] [function_name] [function_arguments]
copy

SYNOPSIS

particle [options] [particle_name/PDG_ID]

PARAMETERS

particle_name/PDG_ID
    The name or PDG ID of the particle to search for. If ommited, it can list possible parameters for a given filter. Example: particle charge

-n, --name particle_name
    Search particle by its name or an alias

-i, --pdgid particle_id
    Search particle by its PDG ID

-v, --verbose
    Enable verbose output for debugging.

-f, --format format_string
    Specify the output format using Python string formatting.

-l, --latex
    Output in LaTeX format.

--version
    Show program's version number and exit

--help
    Show help message and exit

DESCRIPTION

The `particle` command is a Python-based command-line tool designed for manipulating and querying particle data. It provides functionalities for retrieving particle information such as names, IDs, quantum numbers, and masses from a particle database. It is built upon the `Particle` Python package and offers a convenient way to access its features directly from the terminal. The tool is particularly useful for high-energy physics researchers and students involved in particle physics analysis, simulations, and event generation. With the `particle` command, you can quickly find details about particles, verify their properties, and utilize them in your workflows without needing to write custom Python scripts for basic information retrieval. It supports various output formats and search options, allowing you to tailor the information presented to your specific needs.

EXAMPLES

particle Electron
Display information about the Electron.
particle -i 11
Display information about the particle with PDG ID 11.
particle -f '{name} {mass}' Electron
Display only the name and mass of the Electron.

HISTORY

The `particle` command is relatively recent tool and relies heavily on the Particle Python library for its functionalities. Its development aims to simplify access to particle physics data within shell scripting environments, promoting easier integration into existing physics analysis workflows. The command is maintained and improved by the Particle library developers.

SEE ALSO

pdg_id(1)

Copied to clipboard