Commit 8d12b216 authored by liang's avatar liang
Browse files

Improve all sections in poke's readme.rst

parent 467822bd
......@@ -39,6 +39,7 @@ The first Electronic Structure ESDW in Zaragoza in June 2016 was the starting po
./modules/FDF/readme
./modules/pspio/readme
./modules/escdf/readme
./modules/poke/readme
Contributing to this documentation
==================================
......
.. _example:
####
POKE
####
.. sidebar:: Software Technical Information
Language
Fortran 2008
Documentation Tool
Doxygen,Sphinx,ReStructuredText
Application Documentation
`ESL wiki <http://esl.cecam.org/POKE>`_
Licence
L-GPL v3
.. contents:: :local:
Poke is a solver for the Poisson equation designed for electronic structure codes
Purpose of Module
_________________
Poke is a solver for the Poisson equation designed for electronic structure codes. Similarly to the eigensolvers, the aim
is be to implement in a single package several different algorithms of use in different situations, providing a unified
and clean interface for the user. Special attention goes to allowing different FFT back ends to be connected to the
library.
Software Technical Information
______________________________
License
LGPL v3
Language
Fortran 2008
Documentation Tool
Doxygen,Sphinx,ReStructuredText
Application Documentation
`ESL wiki <http://esl.cecam.org/POKE>`_
Instalation
___________
A release can be download from `HERE <https://gitlab.e-cam2020.eu/ESL/poke/tags/Version-Poke-ahi>`_
Current installation and testing are done with gcc compiler. FFTW is required for instalation and testing.
Here are the commands for instalation::
$ tar xfvz poke-ahi.tar.gz
$ ./configure
$ make
.. note ::
We provide also the possibility to build modules with Autotools. `Here <https://gitlab.e-cam2020.eu/ESL/omm/blob/master/libOMM/doc/hacking-the-build-system.md>`_ is a userful document.
Testing
_______
Poke contains several unit tests that can be used to check the
compilation and to perform regression testing. These tests can be
executed by doing::
$ make check
Source Code
___________
The source code is available from the `E-CAM Gitlab`__ under the `poke`__
project. The libOMM directory can be found `here`__.
.. __: https://gitlab.e-cam2020.eu/
.. __: https://gitlab.e-cam2020.eu/ESL/poke/
.. __: https://gitlab.e-cam2020.eu/ESL/poke/tree/develop
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment