Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Shyue Ping Ong committed Apr 5, 2013
1 parent 8499b74 commit 5767869
Show file tree
Hide file tree
Showing 7 changed files with 96 additions and 85 deletions.
12 changes: 11 additions & 1 deletion README.rst
Expand Up @@ -272,12 +272,22 @@ Users are strongly encouraged to explore the detailed `usage pages
<http://pythonhosted.org/pymatgen/usage.html>`_ and `api docs
<http://pythonhosted.org/pymatgen/modules.html>`_.

Example scripts
---------------

A good way to explore the functionality of pymatgen is to look at examples. We
have created a `Github wiki page
<https://github.com/materialsproject/pymatgen/wiki>`_ to allow users to share
their Github gists (essentially mini git repos of scripts) performing various
kinds of functions with pymatgen. Please feel free to check them out and we
welcome your contributions as well!

Add-ons
-------

Some add-ons are available for pymatgen today:

1. The `pymatgen-db add-on <https://pypi.python.org/pypi/pymatgen-db>`_
1. The `pymatgen-db <https://pypi.python.org/pypi/pymatgen-db>`_ add-on
provides tools to create databases of calculated run data using pymatgen.
2. The `custodian <https://pypi.python.org/pypi/custodian>`_ pacakge provides
a JIT job management and error correction for calculations, particularly
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Expand Up @@ -31,7 +31,7 @@

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.viewcode', 'sphinx.ext.autodoc', "sphinxtogithub" ]
extensions = ['sphinx.ext.viewcode', 'sphinx.ext.autodoc']
exclude_patterns = ['../**/tests*']
exclude_dirnames = ['../**/tests*']
autoclass_content = 'both'
Expand Down
17 changes: 16 additions & 1 deletion docs/index.rst
Expand Up @@ -70,6 +70,11 @@ several advantages over other codes out there:
Latest Change Log
=================

Version 2.6.4
-------------
1. Bug fixes for selective dynamics in Poscar.
2. Improved Procar parsing to support both simple and detailed PROCARs.

Version 2.6.3
-------------
1. Added new MaterialsProject REST interfaces for submit/query/delete_snl
Expand Down Expand Up @@ -290,12 +295,22 @@ Users are strongly encouraged to explore the detailed :doc:`usage pages

usage

Example scripts
---------------

A good way to explore the functionality of pymatgen is to look at examples. We
have created a `Github wiki page
<https://github.com/materialsproject/pymatgen/wiki>`_ to allow users to share
their Github gists (essentially mini git repos of scripts) performing various
kinds of functions with pymatgen. Please feel free to check them out and we
welcome your contributions as well!

Add-ons
-------

Some add-ons are available for pymatgen today:

1. The `pymatgen-db add-on <https://pypi.python.org/pypi/pymatgen-db>`_
1. The `pymatgen-db <https://pypi.python.org/pypi/pymatgen-db>`_ add-on
provides tools to create databases of calculated run data using pymatgen.
2. The `custodian <https://pypi.python.org/pypi/custodian>`_ pacakge provides
a JIT job management and error correction for calculations, particularly
Expand Down

0 comments on commit 5767869

Please sign in to comment.