Merge pull request #102 from issp-center-dev/v3.1.0

V3.1.0

.gitattributes

@@ -0,0 +1 @@
+src/dcore/_version.py export-subst

MANIFEST.in

@@ -0,0 +1,2 @@
+include versioneer.py
+include src/dcore/_version.py

doc/about.rst

@@ -29,6 +29,28 @@ We would like to express our sincere gratitude to TRIQS's developers.
 
 This package of ver.1.0 was developed under the support of "Project for advancement of software usability in materials science" by The Institute for Solid State Physics, The University of Tokyo. The copyright of DCore ver.1.0 belongs to The University of Tokyo.
 
+Citing DCore
+-------------------
+If we has used DCore in your research, and you would like to acknowledge the project in your academic publication,
+please cite the following paper:
+
+- `Hiroshi Shinaoka, Junya Otsuki, Mitsuaki Kawamura, Nayuta Takemori, Kazuyoshi Yoshimi, SciPost Phys. 10, 117 (2021) <https://scipost.org/10.21468/SciPostPhys.10.5.117>`_
+
+- BiBTex::
+
+    @Article{10.21468/SciPostPhys.10.5.117,
+        title={{DCore: Integrated DMFT software for correlated electrons}},
+        author={Hiroshi Shinaoka and Junya Otsuki and Mitsuaki Kawamura and Nayuta Takemori and Kazuyoshi Yoshimi},
+        journal={SciPost Phys.},
+        volume={10},
+        issue={5},
+        pages={117},
+        year={2021},
+        publisher={SciPost},
+        doi={10.21468/SciPostPhys.10.5.117},
+        url={https://scipost.org/10.21468/SciPostPhys.10.5.117},
+     }
+
 Authors & Quotation
 -------------------
 

setup.cfg

@@ -0,0 +1,7 @@
+[versioneer]
+VCS = git
+style = pep440
+versionfile_source = src/dcore/_version.py
+versionfile_build = dcore/_version.py
+tag_prefix =
+parentdir_prefix = dcore-

setup.py

@@ -2,14 +2,16 @@
 Setup script for irbasis_x
 """
 from setuptools import setup, find_packages
+import versioneer
 
-VERSION = '3.0.0'
+#VERSION = '3.0.0'
 REPO_URL = "https://github.com/issp-center-dev/DCore.git"
 LONG_DESCRIPTION = ""
 
 setup(
     name='dcore',
-    version=VERSION,
+    version=versioneer.get_version(),
+    cmdclass=versioneer.get_cmdclass(),
 
     description='DMFT software for CORrelated Electrons',
     #long_description=LONG_DESCRIPTION,
@@ -44,7 +46,7 @@
         'h5py',
         ],
     extras_require={
-        'dev': ['pytest', 'sphinx', 'matplotlib', 'wild_sphinx_theme'],
+        'dev': ['pytest', 'sphinx', 'matplotlib', 'wild_sphinx_theme', 'versioneer'],
         },
 
     setup_requires=[

src/dcore/__init__.py

@@ -23,4 +23,6 @@
     import irbasis_x
     irbasis_x_available = True
 except ImportError:
-    pass
+    pass
+from . import _version
+__version__ = _version.get_versions()['version']