From aa07077812a54578c74934681def53226d90aacd Mon Sep 17 00:00:00 2001 From: "Marcel R." Date: Fri, 18 Oct 2024 19:07:43 +0200 Subject: [PATCH] Clean README. --- README.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/README.md b/README.md index 3fcc7fbe..c0e841cd 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,6 @@ Key features: - ## Contents @@ -74,7 +73,6 @@ Key features: - ## First steps @@ -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: @@ -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. @@ -179,7 +173,6 @@ docker run -ti riga/law:example - [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 @@ -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. @@ -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: @@ -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)).