diff --git a/README.rst b/README.rst index 6294bdb7..b226c442 100644 --- a/README.rst +++ b/README.rst @@ -1,16 +1,24 @@ -**Official docs:** http://pythonhosted.org/abipy/ +:Repository: https://github.com/gmatteo/abipy +:Author: Matteo Giantomassi (http://github.com/gmatteo) +.. image:: https://pypip.in/v/abipy/badge.png + :target: https://pypi.python.org/pypi/abipy + +About +===== Abipy is an open-source library for the analysis of the results produced by ABINIT (http://www.abinit.org), an open-source program for the ab-initio calculation of the physical properties of materials within Density Functional Theory (DFT). Abipy is written in Python and is designed with the philosophy that you should be able to create simple plots with just a few commands. + +Documentation available at http://pythonhosted.org/abipy/ Check out the the list of plotting scripts available in the `examples/plot `_ directory. To learn more about abipy, you can visit our example collection of ipython `notebooks `_ -and the abipy `lessons -`_. +and the abipy +`lessons `_. Abipy is free to use. However, we also welcome your help to improve this library by making your own contributions. These contributions can be in the form of additional tools or modules you develop, or even simple things @@ -105,9 +113,6 @@ Optional libraries that are required if you need certain features: The directory `abipy.gui.demos` contains demos that can be used to test the installation (run the script `runall.py` to have an overview of the different graphical interfaces). -See the ``INSTALL_HOTWO.rst`` - - Using abipy =========== @@ -119,8 +124,6 @@ Below is a brief description of the different directories found there: * plot - scripts showing how to produce plots with matplotlib - * htc - usage examples of the High-throughput API. - * notebooks - ipython notebooks (use `ipython notebook FILE` to open the notebook in your browser)