Skip to content

Commit

Permalink
add CLI doc
Browse files Browse the repository at this point in the history
  • Loading branch information
JannisNe committed Feb 10, 2025
1 parent e989ddd commit fc54359
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,20 @@ You will need the [IRSA login details](https://irsa.ipac.caltech.edu/account/sig

Additionally, you need an AMPEL API token. This can be obtained [here](https://ampel.zeuthen.desy.de/live/dashboard/tokens).

# CLI for IceCube neutrino counterparts
`nuztf` comes with a command line interface to scan for counterparts to IceCube neutrino alerts. To be eble to use it, you must install the `cli` extra dependencies:

```pip install nuztf[cli]```

or

```poetry install -E cli```

For usage information run:

```nuztf --help```


# Citing the code

If you make use of this code, please cite it! A DOI is provided by Zenodo, which can reference both the code repository, or specific releases:
Expand Down

0 comments on commit fc54359

Please sign in to comment.