Skip to content

Commit

Permalink
add badges, dev install instructions and fix package name
Browse files Browse the repository at this point in the history
  • Loading branch information
nmaeder committed Jun 24, 2024
1 parent 713341f commit 270e2f6
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Nonadditivity analysis

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
![Tests](https://github.com/ChristianKramer/NonadditivityAnalysis/actions/workflows/CI.yml/badge.svg)

## Synposis

A program to find key complex patterns in SAR data
Expand All @@ -21,7 +24,17 @@ where 3.* == 3.10, 3.11 or 3.12 and <env_name> is the name of your conda environ
Then use the following command to install the programm.

```shell
pip install roche-nonadditivity
pip install nonadditivity
```
### Dev Mode

Install the code in development mode with:

```bash
$ git clone git+https://github.com/KramerChristian/NonadditivityAnalysis.git
$ cd NonadditivityAnalysis
$ pip install poetry
$ poetry install
```

## How to run the program and get help
Expand Down

0 comments on commit 270e2f6

Please sign in to comment.