-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added min python version to readme and README.txt
- Loading branch information
Showing
7 changed files
with
101 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
|Build Status| |Coverage Status| | ||
|
||
**crystal\_torture:** | ||
~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
``crystal_torture`` is a Python, Fortran and OpenMP crystal structure | ||
analysis module. The module contains a set of classes that enable: | ||
|
||
- a crystal structure to be converted into a graph for network analysis | ||
- connected clusters of crystal sites (nodes) to be retrieved and | ||
output | ||
- periodicity of connected clusters of crystal sites to be determined | ||
- relative path tortuosity to traverse a crystal within a connected | ||
cluster to be calculated for each site | ||
|
||
Installation | ||
------------ | ||
|
||
`crystal_torture` requires python 3.5 and above. To install do: | ||
|
||
:: | ||
|
||
pip install crystal_torture | ||
|
||
or download directly from | ||
`GitHub <http://github.com/connorourke/crystal_torture/releases>`__, or | ||
clone: | ||
|
||
:: | ||
|
||
git clone https://github.com/connorourke/crystal_torture | ||
|
||
and install | ||
|
||
:: | ||
|
||
cd crystal_torture | ||
python setup.py install | ||
|
||
Tests | ||
----- | ||
|
||
``crystal_torture`` is automatically tested on each commit | ||
`here <http://travis-ci.org/connorourke/crystal_torture>`__, but the | ||
tests can be manually run: | ||
|
||
:: | ||
|
||
python -m unittest discover | ||
|
||
Examples | ||
-------- | ||
|
||
Examples on how to use ``crystal_torture`` can be found in a Jupyter | ||
notebook in the ``examples`` directory | ||
`crystal\_torture\_examples.ipynb <http://nbviewer.jupyter.org/github/connorourke/crystal_torture/blob/master/examples/crystal_torture_examples.ipynb>`__ | ||
|
||
Documentation | ||
------------- | ||
|
||
Documentation can be found | ||
`here <https://crystal-torture.readthedocs.io/en/latest/>`__ | ||
|
||
.. |Build Status| image:: https://travis-ci.com/connorourke/crystal_torture.svg?token=nTMqYYEUasQRTBsU6oCc&branch=master | ||
:target: https://travis-ci.com/connorourke/crystal_torture | ||
.. |Coverage Status| image:: https://coveralls.io/repos/github/connorourke/crystal_torture/badge.svg?branch=master | ||
:target: https://coveralls.io/github/connorourke/crystal_torture?branch=master |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
ddt | ||
coverage | ||
numpy | ||
pymatgen | ||
ddt | ||
numpy>=1.15.4 | ||
f90wrap | ||
pymatgen |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters