Skip to content

Commit

Permalink
Clean README.
Browse files Browse the repository at this point in the history
  • Loading branch information
riga committed Oct 18, 2024
1 parent 5d71532 commit aa07077
Showing 1 changed file with 0 additions and 11 deletions.
11 changes: 0 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ Key features:

<!-- marker-after-header -->


## Contents

<!-- marker-before-contents -->
Expand All @@ -74,7 +73,6 @@ Key features:

<!-- marker-after-contents -->


<!-- marker-before-body -->

## First steps
Expand All @@ -99,17 +97,14 @@ If you plan to use remote targets, the (default) implementation also requires [g
conda install -c conda-forge gfal2 gfal2-util
```


### Usage at CERN

See the [wiki](https://github.com/riga/law/wiki/Usage-at-CERN).


### Overcomplete example config

See [law.cfg.example](https://github.com/riga/law/tree/master/law.cfg.example).


## Projects using law

- CMS Di-Higgs Inference Tools:
Expand Down Expand Up @@ -148,7 +143,6 @@ See [law.cfg.example](https://github.com/riga/law/tree/master/law.cfg.example).

If your project uses law but is not yet listed here, feel free to open a pull request or mention your project details in a new [issue](https://github.com/riga/law/issues/new?assignees=riga&labels=docs&template=register-project.md) and it will be added.


## Examples

All examples can be run either in a Jupyter notebook or a dedicated docker container.
Expand Down Expand Up @@ -179,7 +173,6 @@ docker run -ti riga/law:example <example_name>
- [notifications](https://github.com/riga/law/tree/master/examples/notifications): Demonstration of slack and telegram task status notifications..
- [CMS Single Top Analysis](https://github.com/riga/law_example_CMSSingleTopAnalysis): Simple physics analysis using law.


## Further topics

### Auto completion on the command-line
Expand Down Expand Up @@ -216,13 +209,11 @@ If this is the case, just source the law completion script (which internally ena
source "$( law completion )"
```


## Development

- Source hosted at [GitHub](https://github.com/riga/law)
- Report issues, questions, feature requests on [GitHub Issues](https://github.com/riga/law/issues)


### Tests

The test pipeline consists of unit tests, linting, and type checking.
Expand All @@ -243,7 +234,6 @@ Each of these steps be run in a local environment or via docker.

**Note** that, although Python 3.7 is still suppported, type hints are tested only for Python ≥3.8!


### Git hooks

Linting and type checking can be integrated into the git workflow by setting up the provided hook:
Expand All @@ -256,7 +246,6 @@ Linting and type checking can be integrated into the git workflow by setting up
By default, the hook is triggered *after* each commit and *always passes*.
Use `git commit --amend` to add local changes to the previous commit if needed.


### Docker images

There are various docker `riga/law` images available on the [DockerHub](https://cloud.docker.com/u/riga/repository/docker/riga/law), corresponding to different OS and Python versions (based on [micromamba](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html)).
Expand Down

0 comments on commit aa07077

Please sign in to comment.