Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fixed outdated repository URL and improved installation instructions.
  • Loading branch information
HealthyPear authored Jul 23, 2024
1 parent f9a3e45 commit 5e03959
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,15 @@ Supported background generation modes:
Clone and install with `pip`:

```
git clone https://gitlab.pic.es/mstrzys/pybkgmodel.git
cd pybkgmodel
pip install .
git clone https://github.com/cta-observatory/pybkgmodel.git
pip install pybkgmodel
```

> [!IMPORTANT]
> In case you are a developer you should install the package in editable mode enabling the test
> dependecies with
> `pip install -e 'pybkgmodel[tests]'`.
## Usage
The background model generation is controlled via a configuration file in the YAML format (an example may be found in the "examples" folder). It specifies the input data, output folder, background model generation method, maps binning and exclusion regions to apply.

Expand Down

0 comments on commit 5e03959

Please sign in to comment.