Skip to content

Commit 1df8547

Browse files
committed
Update docs and version bump
1 parent d9ee934 commit 1df8547

File tree

170 files changed

+229
-205
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

170 files changed

+229
-205
lines changed

.githooks/license_maintainer.py

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def add_header(filepath, header, YEAR, AUTHORS):
5252
output.append(inpt[0] + '\n')
5353
inpt = inpt[1:]
5454
regex = re.compile(r'Copyright \(C\).*\n')
55-
repl = r'Copyright (C) ' + YEAR + ' ' + AUTHORS + '\n'
55+
repl = r'Copyright (C) ' + YEAR + ' ' + AUTHORS + '\n'
5656
output.extend([re.sub(regex, repl, x) for x in inpt])
5757
else:
5858
print(('Adding header in {}'.format(filepath)))
@@ -82,7 +82,7 @@ def prepare_header(stub, YEAR, AUTHORS):
8282
with open(stub, 'r') as l:
8383
header = l.read()
8484
# Insert correct YEAR and AUTHORS in stub
85-
rep = {'YEAR' : YEAR, 'AUTHORS' : AUTHORS}
85+
rep = {'YEAR': YEAR, 'AUTHORS': AUTHORS}
8686
rep = dict((re.escape(k), v) for k, v in rep.items())
8787
pattern = re.compile("|".join(list(rep.keys())))
8888
header = pattern.sub(lambda m: rep[re.escape(m.group(0))], header)
@@ -105,24 +105,25 @@ def file_license(attributes):
105105
# Remove licensefile= from strings
106106
lic = [re.sub(r'licensefile\=', '', x) for x in gitattributes if 'licensefile' in x]
107107
# Create list of blacklisted files
108-
blacklist = [fname for key, value in list(dict(list(zip(fil, lic))).items())
109-
if value == '!licensefile'
110-
for fname in glob.glob(key)]
108+
blacklist = [
109+
fname for key, value in list(dict(list(zip(fil, lic))).items())
110+
if value == '!licensefile' for fname in glob.glob(key)
111+
]
111112
# Now create a dictionary with the files to be considered for
112113
# license header manipulation
113-
file_license = {key: value
114-
for k, value in list(dict(list(zip(fil, lic))).items())
115-
for key in glob.glob(k)
116-
if key not in blacklist}
114+
file_license = {
115+
key: value
116+
for k, value in list(dict(list(zip(fil, lic))).items()) for key in glob.glob(k) if key not in blacklist
117+
}
117118
return file_license
118119

119120

120121
def license_maintainer():
121122
"""
122123
Maintain license header in source files
123124
"""
124-
YEAR = str(date.today().year)
125-
AUTHORS = 'Roberto Di Remigio, Luca Frediani and collaborators.'
125+
YEAR = str(date.today().year)
126+
AUTHORS = 'Roberto Di Remigio, Luca Frediani and contributors.'
126127

127128
script_dir = os.path.dirname(os.path.abspath(__file__))
128129
project_root_dir = os.path.abspath(os.path.join(script_dir, os.pardir))

AUTHORS.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Individual Contributors
2+
3+
- Roberto Di Remigio
4+
- Luca Frediani
5+
- Monica Bugeanu
6+
- Radovan Bast
7+
- T. Daniel Crawford
8+
- Arnfinn Hykkerud Steindal
9+
- Krzysztof Mozgawa
10+
- Lori A. Burns
11+
- Ville Weijo
12+
- Ward Poelmans
13+
14+
This list was obtained 2018-01-20 by running `git shortlog -sn`

CHANGELOG.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Change Log
22

3-
## [Unreleased]
3+
## [Version 1.1.12] - 2018-01-20
44

55
### Added
66

@@ -425,7 +425,8 @@
425425

426426
## v1.0.0 - 2014-09-30 [YANKED]
427427

428-
[Unreleased]: https://github.com/PCMSolver/pcmsolver/compare/v1.1.11..HEAD
428+
[Unreleased]: https://github.com/PCMSolver/pcmsolver/compare/v1.1.12..HEAD
429+
[Version 1.1.11]: https://github.com/PCMSolver/pcmsolver/compare/v1.1.11...v1.1.12
429430
[Version 1.1.11]: https://github.com/PCMSolver/pcmsolver/compare/v1.1.10...v1.1.11
430431
[Version 1.1.10]: https://github.com/PCMSolver/pcmsolver/compare/v1.1.9...v1.1.10
431432
[Version 1.1.9]: https://github.com/PCMSolver/pcmsolver/compare/v1.1.8...v1.1.9

README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,19 @@
77
PCMSolver
88
=========
99

10-
An API for the Polarizable Continuum Model.
10+
An API for the Polarizable Continuum Model. Copyright [Roberto Di Remigio](mailto:[email protected]),
11+
[Luca Frediani](mailto:[email protected]) and [contributors](https://github.com/PCMSolver/pcmsolver/blob/release/1.Y/AUTHORS.md)
1112

1213
- [Project website](https://github.com/PCMSolver/pcmsolver)
1314
- [Changelog](CHANGELOG.md)
1415
- [Documentation](http://pcmsolver.readthedocs.io)
1516
- [Build and test history](https://travis-ci.org/PCMSolver/pcmsolver/builds)
16-
- [Build dashboard](https://testboard.org/cdash/index.php?project=PCMSolver)
17-
- Version 1.1.11 available
17+
- Version 1.1.12 available
1818
- Licensed under [LGPLv3](LICENSE)
1919
- CMake infrastructure managed *via* [Autocmake](http://autocmake.readthedocs.io/)
2020

21-
Primary test environments
22-
=========================
23-
24-
All builds force custom build of the needed Boost libraries, except when
25-
stated otherwise.
26-
2721
Continuous integration builds
28-
-----------------------------
22+
=============================
2923

3024
All CI builds are triggered by push events to any branch.
3125
Travis CI runs release builds using [ccache](https://ccache.samba.org/) to speed up compilation.

api/PCMInput.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* PCMSolver, an API for the Polarizable Continuum Model
3-
* Copyright (C) 2018 Roberto Di Remigio, Luca Frediani and collaborators.
3+
* Copyright (C) 2018 Roberto Di Remigio, Luca Frediani and contributors.
44
*
55
* This file is part of PCMSolver.
66
*

api/pcmsolver.f90

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
!
22
! PCMSolver, an API for the Polarizable Continuum Model
3-
! Copyright (C) 2018 Roberto Di Remigio, Luca Frediani and collaborators.
3+
! Copyright (C) 2018 Roberto Di Remigio, Luca Frediani and contributors.
44
!
55
! This file is part of PCMSolver.
66
!

api/pcmsolver.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* PCMSolver, an API for the Polarizable Continuum Model
3-
* Copyright (C) 2018 Roberto Di Remigio, Luca Frediani and collaborators.
3+
* Copyright (C) 2018 Roberto Di Remigio, Luca Frediani and contributors.
44
*
55
* This file is part of PCMSolver.
66
*

default.nix

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,20 @@ let
44
owner = "NixOS";
55
repo = "nixpkgs-channels";
66
rev = "nixos-unstable";
7-
sha256 = "0q47hjl01wylp6cdb52fyjbbx45djnz7bwfyj2mfv2lh04iph3s8";
7+
sha256 = "15fcl29a97f68j1pjywmrjm31rdh1a21jz9airlsbzpl4lc3zhfi";
88
});
99
in
1010
with import nixpkgs {
1111
overlays = [(self: super:
12-
# Within the overlay we use a recursive set, though I think we can use `self` as well.
13-
rec {
14-
# nix-shell -p python.pkgs.my_stuff
12+
{
1513
python3 = super.python3.override {
16-
# Careful, we're using a different self and super here!
1714
packageOverrides = py-self: py-super: {
1815
matplotlib = py-super.matplotlib.override {
1916
enableTk = true;
2017
enableQt = true;
2118
};
2219
};
2320
};
24-
python3Packages = python3.pkgs;
2521
}
2622
)];
2723
};
@@ -39,22 +35,21 @@ in
3935
exa
4036
ffmpeg
4137
gfortran
38+
gfortran.cc.lib
4239
graphviz
43-
lldb
4440
pipenv
4541
python3Full
4642
python3Packages.docopt
4743
python3Packages.jupyter
4844
python3Packages.matplotlib
4945
python3Packages.numpy
5046
python3Packages.pyyaml
51-
python3Packages.virtualenvwrapper
5247
valgrind
5348
zlib
5449
];
5550
src = null;
5651
shellHook = ''
57-
NINJA_STATUS="[Built edge %f of %t in %e sec]"
58-
SOURCE_DATE_EPOCH=$(date +%s)
52+
export NINJA_STATUS="[Built edge %f of %t in %e sec]"
53+
SOURCE_DATE_EPOCH=$(date +%s)
5954
'';
6055
}

doc/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33

44

5+
56
#
67
# PCMSolver, an API for the Polarizable Continuum Model
7-
# Copyright (C) 2018 Roberto Di Remigio, Luca Frediani and collaborators.
8+
# Copyright (C) 2018 Roberto Di Remigio, Luca Frediani and contributors.
89
#
910
# This file is part of PCMSolver.
1011
#

doc/gfx/cloc_tools.py.in

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33

44

5+
56
#
67
# PCMSolver, an API for the Polarizable Continuum Model
7-
# Copyright (C) 2018 Roberto Di Remigio, Luca Frediani and collaborators.
8+
# Copyright (C) 2018 Roberto Di Remigio, Luca Frediani and contributors.
89
#
910
# This file is part of PCMSolver.
1011
#

0 commit comments

Comments
 (0)