Skip to content

Commit

Permalink
Adding notes on deprecation of this repo
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickfuller committed Jan 8, 2014
1 parent f24b19c commit 44b0dc7
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,37 @@
EQeq
====

Charge equilibration method for crystal structures
Charge equilibration method for crystal structures.

# NOTE
The EQeq charge equilibration algorithm is now included as a feature in the
[openbabel](http://openbabel.org/wiki/Main_Page) project, enabling its use with
over 100 chemical file formats across multiple programming languages. As such,
this version of the algorithm is no longer in development - please switch to
openbabel.

To run EQeq from openbabel, use these sample code snippets as a starting point:

```python
# Python
import pybel
mol = pybel.readfile("cif", "filename.cif")
pybel.ob.OBChargeModel_FindType("eqeq").ComputeCharges(mol.OBMol)
partial_charges = [atom.partialcharge for atom in mol]
```

```c++
// C++
OBMol inputMolecule;
OBChargeModel *eqeqCharges = OBChargeModel::FindType("eqeq");
eqeqCharges->ComputeCharges(inputMolecule);
vector<double> partialCharges = eqeqCharges->GetPartialCharges();
```
Other languages, file types, and charge models are also supported - read the
openbabel docs for more.
###Summary
The source code in this program demonstrates the charge equilibration method described
in the accompanying paper. The purpose of the source code provided is to be
Expand Down
6 changes: 5 additions & 1 deletion eqeq.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@
except:
sys.stderr.write("Openbabel not found. Format conversion unsupported.\n"
"Only use cif files for output, and cif/mol/pdb/car/files"
" for output.")
" for output.\n")

sys.stderr.write("This version of EQeq is deprecated. Please switch to the "
"version maintained by the openbabel project (see the README "
"for more).\n")

eqeq = cdll.LoadLibrary("/usr/lib/libeqeq.so")
eqeq.run.argtypes = (c_char_p, c_char_p, c_double, c_float, c_int, c_char_p,
Expand Down

0 comments on commit 44b0dc7

Please sign in to comment.