README
======

This README is in the doc directory of the abinit package.
See the file `help_new_user.html` in the `doc/users/generated_files`
directory for more information.
See also <https://www.abinit.org/documentation/helpfiles>

The ABINIT project is described in several publications, including:
"ABINIT: First-principles approach to material and nanosystem properties", Computer Physics Communications 180, 2582--2615 (2009)
"Organizing software growth and distributed development: The case of abinit", Computing in Science and Engineering 13, 62-69 (2011)

For installation, compilation and tests,
see a recent version of the 'install' file, in the `doc/install_notes` subdirectory.
This file is also available on the Web, see <https://www.abinit.org/documentation/helpfiles>.

Part of the ABINIT documentation is automatically generated by python scripts.
Issue 
python generate_doc.py
to regenerate it.

