Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zhuligs committed Sep 17, 2024
1 parent d1272df commit a7e8b10
Showing 1 changed file with 37 additions and 13 deletions.
50 changes: 37 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,51 @@
# Fplib
Fplib is is a library for calculating fingerprint and measuring similarites of materials (e.g. crystals, clusters, and molecules). The library is written in C, with python interface.
# fplib

The detailed algorithm of fplib is describted the following paper:
Fplib is a library for calculating fingerprints and measuring similarities of materials (e.g., crystals, clusters, and molecules). The library is written in C with a Python interface.

- "[A fingerprint based metric for measuring similarities of crystaline structures](http://scitation.aip.org/content/aip/journal/jcp/144/3/10.1063/1.4940026)",
Li Zhu, Maximilian Amsler, Tobias Fuhrer, Bastian Schaefer, Somayeh Fareji, Alireza Ghasemi, Migle Grauzinyte, Chris Wolverton, and Stefan Goedecker
**J. Chem. Phys. 144**, 034203 (2016)

## Installation

### Prerequisites

Before installing python-fplib, ensure you have the following:

- Python header files (python-dev)
- C compiler (e.g., gcc, clang)
- NumPy
- OpenBLAS

### Installation Steps

# Installation
1. Clone the repository:
```
git clone https://github.com/Rutgers-ZRG/fplib.git
cd fplib
```

To install python-fplib using `setup.py`, python header files (python-dev), C-compiler (e.g., gcc, clang), numpy, and lapack (openblas, atlas, Intel-MKL) are required before the build. The installation steps are shown as follows:
2. Install using pip:
```
pip install .
```

1. Go to the fppy directory
## Usage

2. Type the command:
To use fplib in your Python project:

`% pip install .
```python
import fplib


# Your code here
```

# Example
## Examples

Example
Examples are found in `examples` directory.

## Algorithm

The detailed algorithm of fplib is described in the following paper:

- "[A fingerprint based metric for measuring similarities of crystalline structures](http://scitation.aip.org/content/aip/journal/jcp/144/3/10.1063/1.4940026)",
Li Zhu, Maximilian Amsler, Tobias Fuhrer, Bastian Schaefer, Somayeh Fareji, Alireza Ghasemi, Migle Grauzinyte, Chris Wolverton, and Stefan Goedecker
**J. Chem. Phys. 144**, 034203 (2016)

0 comments on commit a7e8b10

Please sign in to comment.