Metadata-Version: 2.4
Name: nsdf-dark-matter-cli
Version: 0.6.0
Summary: NSDF Dark Matter CLI
Author-email: NSDF Team <info@nationalsciencedatafabric.org>
Project-URL: documentation, https://nsdf-fabric.github.io/nsdf-slac/
Project-URL: source, https://github.com/nsdf-fabric/nsdf-slac
Project-URL: tracker, https://github.com/nsdf-fabric/nsdf-slac/issues
Project-URL: release notes, https://github.com/nsdf-fabric/nsdf-slac/releases
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: typer==0.16.0
Requires-Dist: requests>=2.34.2

# NSDF Dark Matter CLI

The `nsdf_dark_matter` CLI offers a pool of operations to access and download the R76 dark matter dataset. The CLI serves as a top level component to access data in a workflow which can
then be analyzed with the [NSDF Dark Matter Library](https://nsdf-fabric.github.io/nsdf-slac/library/). Check the [CLI guide](https://nsdf-fabric.github.io/nsdf-slac/cli/) for a step by step walkthrough.

## NSDF CLI Usage Example

### Listing remote files

```bash
nsdf-cli ls
```

### Downloading a dataset

```bash
nsdf-cli download 07180827_0000_F0001
```

Download all series matching a prefix with the `--all` flag:

```bash
nsdf-cli download 07180808_1558 --all
```

Download multiple series

```txt
07180808_1558_F0006
07180808_1558_F0007
07180808_1558_F0008
07180808_1558_F0009
```

```bash
nsdf-cli download -f download.txt
```

Download into a specific output directory:

```bash
nsdf-cli download 07180827_0000_F0001 -o /path/to/output
```
