Skip to content

Commit

Permalink
Update README for the new CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
HealthyPear authored Oct 31, 2024
1 parent 1382735 commit c46de97
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,15 @@ For the moment there is no public packaged release.

## Usage

You can use the package using the available command line entry points,
You can use the package using the available command line entry points.

1. get the default configuration file with `iact-estimator-cfg`
2. launch the estimation with `iact-estimator`
Assuming you are working from a directory called `project`

1. get the default configuration file with `iact-estimator config`
2. launch the estimation with `iact-estimator run --config config.yml --source-name "Crab Nebula"`

> [!NOTE]
> Currently the source name must be a valid identifier from the SIMBAD, NED or VizieR databases.
For more details use the `-h` option to show the help menu.

Expand Down

0 comments on commit c46de97

Please sign in to comment.