forked from plumed/plumed2
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge commit 'astyle-master~1' into topology-matrix
- Loading branch information
Showing
199 changed files
with
107,252 additions
and
78,919 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
-n --indent=spaces=2 --keep-one-line-statements --keep-one-line-blocks |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
|
||
Content | ||
------- | ||
|
||
CHANGES/ : change log | ||
COPYING.LESSER : license | ||
Makefile : makefile | ||
Makefile.conf.in : template configuration makefile | ||
PEOPLE : list of authors | ||
README : this file | ||
VERSION : version file | ||
configurations/ : template configuration files | ||
configure : configuration script | ||
configure.ac : configuration script (autoconf) | ||
developer-doc : developer documentation | ||
include : symbolic link for include files | ||
macports : directory where Portfiles are generated | ||
patches : patch scripts | ||
release.sh : developer utility to publish releases | ||
regtest : regression tests, including reference results | ||
scripts : shell tools | ||
src : source code | ||
sourceme.sh : template configuration script | ||
test : examples | ||
user-doc : user documentation | ||
vim : directory where vim syntax is generated | ||
|
||
Install | ||
------- | ||
|
||
Extensive installation instructions are in the user documentation. | ||
Links to precompiled versions of the documentation can be found [here](http://www.plumed.org/documentation). | ||
|
||
Required software: | ||
|
||
* GNU make | ||
* C/c++ compiler (c++11 support is required as of version 2.4). | ||
* A modern version of the `patch` command line tool | ||
* Support for POSIX library `dirent.h` | ||
* `xxd` (present in most unix distributions) | ||
|
||
Suggested software (libraries are checked by `./configure` and enabled if available): | ||
|
||
* Optimized blas and lapack libraries. Can be replaced by an internal version if not available. | ||
* MPI library to run parallel simulations. It should be the same library used by your MD code. | ||
* [VMD molfile plugins](http://www.ks.uiuc.edu/Research/vmd/plugins) to read arbitrary file formats. Can be replaced by an internal version supporting a few formats if not available. | ||
* [Matheval library](http://www.gnu.org/software/libmatheval) to use algebraic collective variables. | ||
* [Zlib library](http://zlib.net/) to use compressed data files. | ||
* [Xdrfile library](http://www.gromacs.org/Developer_Zone/Programming_Guide/XTC_Library) to have read/write access to gromacs | ||
trajectory files. | ||
* [Doxygen](http:://www.doxygen.org) to build user manual. Doxygen might need the following packages: | ||
* Latex to build the pdf user manual. | ||
* [Graphviz](http://www.graphviz.org) to show class hierarchy in | ||
developer manual. | ||
|
||
Quick compilation instructions | ||
------------------------------ | ||
|
||
Configure for your system | ||
|
||
./configure --prefix=$HOME/opt | ||
|
||
|
||
If necessary, edit `Makefile.conf`. | ||
Configure your environment | ||
|
||
source ./sourceme.sh | ||
|
||
Compile plumed | ||
|
||
make | ||
|
||
The `plumed` executable should be now in your execution path | ||
|
||
plumed help | ||
|
||
Compile the manuals (pre-compiled manual is available online): | ||
|
||
make doc | ||
|
||
User documentation can be found at `user-doc/html/index.html`. | ||
Developer documentation can be found at `developer-doc/html/index.html`. | ||
|
||
Install PLUMED in `$HOME/opt` (directory should be set during `./configure`): | ||
|
||
umask 022 | ||
make install | ||
|
||
A sample modulefile with environment variable will be placed in | ||
`$HOME/opt/lib/plumed/src/lib/modulefile`. Path to the installed documentation can be found with command `plumed info --user-doc`. | ||
|
||
|
||
Branches and releases | ||
--------------------- | ||
|
||
Several branches and tags are stored on the git repository. | ||
|
||
Branches named `v2.X` correspond to release branches. | ||
|
||
Master branch may contain non tested features and is not expected to be used by non-developers. | ||
It typically contains features that will be available on the next release. | ||
|
||
Tags named `v2.XbY` correspond to beta releases, use it with care. | ||
Tags named `v2.X.Y` correspond to official releases, use the latest available. | ||
|
||
To report problems found on beta or official releases, use the normal `[email protected]` | ||
mailing list. Just state exactly which version you are using. | ||
|
||
To report problems found on `master` branch, use the `[email protected]` mailing list. | ||
This is also the correct place for discussions about new features etc. | ||
When reporting please provide the git hash (you can obtain it with `git rev-parse HEAD`). | ||
|
||
Status | ||
------ | ||
|
||
| Branch | Status | Supported | | ||
|:--------:|:-------------:|:--------:| | ||
| master | [](https://travis-ci.org/plumed/plumed2) | yes | | ||
| v2.3 | [](https://travis-ci.org/plumed/plumed2) | yes | | ||
| v2.2 | [](https://travis-ci.org/plumed/plumed2) | no | | ||
| v2.1 | [](https://travis-ci.org/plumed/plumed2) | no | | ||
| v2.0 | Not available | no | | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
astyle |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
### MIT License | ||
|
||
Copyright (c) 2017 by Jim Pattee <[email protected]>. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
.PHONY: astyle | ||
|
||
astyle: | ||
$(MAKE) -C build/gcc | ||
ln -fs build/gcc/bin/astyle . | ||
|
||
clean: | ||
$(MAKE) -C build/gcc clean | ||
rm -f astyle |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
Instructions for using Artistic Style are included in the *doc* directory. | ||
|
||
The file **install.html** contains instructions for compiling and | ||
installing Artistic Style. | ||
|
||
The file **astyle.html**' contains information on using Artistic Style. | ||
|
||
The files **news.html** and **notes.html** contain information on changes | ||
made to the various releases. |
Oops, something went wrong.