diff --git a/.pylintrc b/.pylintrc index d1fc4ceb..ca66376e 100644 --- a/.pylintrc +++ b/.pylintrc @@ -10,7 +10,7 @@ # Add files or directories to the blacklist. They should be base names, not # paths. -ignore= +ignore=_version.py # Add files or directories matching the regex patterns to the blacklist. The # regex matches against base names, not paths. diff --git a/pmda/__init__.py b/pmda/__init__.py index 0cb2abd0..317ff9e7 100644 --- a/pmda/__init__.py +++ b/pmda/__init__.py @@ -7,6 +7,25 @@ # # Released under the GNU Public Licence, v2 or any higher version +""" +PMDA --- Parallel MDAnalysis +============================ + +Ready to use analysis and buildings blocks to write parallel analysis +algorithms using MDAnalysis with dask. + +The full documentation can be found at https://www.mdanalysis.org/pmda/. + +Note that by default no modules are imported in the top-level name +space. Import what you need:: + + import pmda.parallel + import pmda.custom + import pmda.rms + import pmda.contacts + +""" + from ._version import get_versions __version__ = get_versions()['version'] del get_versions