Skip to content

Commit

Permalink
Expanding README.md (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
ifilot committed May 1, 2024
1 parent 82c9298 commit e19920f
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@

## Purpose

> [Go to the documentation](https://bramble.imc-tue.nl).
> [!TIP]
> Detailed documentation can be found [here](https://bramble.imc-tue.nl).
Bramble is a single atom pattern recognition algorithm based on the Common
Neighbor Analysis method. It can efficiently construct CNA fingerprints per
Expand Down Expand Up @@ -98,4 +99,14 @@ you would normally use for running Bramble.

```bash
docker exec -it bramble /bin/bash
```

Go to the `/home/bramble/data` folder and make sure you have copied
`patterns.json` and `pa_fcc111.txt` to this folder.
Since the `bramble` executable is available from the path, you
can directly invoke it. To perform a pattern identification, run

```bash
cd /home/bramble/data
bramble -p patterns.json -i POSCAR_Rh111 -o pa_fcc111.txt
```

0 comments on commit e19920f

Please sign in to comment.