Skip to content

Commit

Permalink
Merge pull request #117 from MartinWenge/master
Browse files Browse the repository at this point in the history
updating and adding papers to the references in README
  • Loading branch information
Bondoki authored Oct 2, 2020
2 parents bd50e22 + 3407a67 commit d16ef40
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 20 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,10 @@ LeMonADE 2.1
* modify FeatureAttribute: now uses a template parameter `FeatureAttribute<>`, default=`int32_t`
* improvement of utilities: DistanceCalculation
* introduce continuous integration: CircleCi

LeMonADE 2.2
* add moveable Tags
* add an updater for a swelling box
* add analyzers for the calculation of the mean-square displacement
* add various features and moves to enable reactive and reversible bonds

46 changes: 26 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ The abbreviation LeMonADE stands for
"**L**attice-based **e**xtensible **Mon**te-Carlo **A**lgorithm and **D**evelopment **E**nvironment".

The aim of the LeMonADE-project is an open source implementation of the
bond-fluctuation-model ([BFM1], [BFM2]) for simulating polymeric systems using generic
template metaprogramming in C++.
[bond fluctuation model](https://en.wikipedia.org/wiki/Bond_fluctuation_model) ([BFM1], [BFM2]) for simulating polymeric systems using generic
template metaprogramming in `C++`.

[BFM1]: http://dx.doi.org/10.1021/ma00187a030 "I. Carmesin, K. Kremer; Macromolecules 21, 2819-2823 (1988)"

Expand Down Expand Up @@ -36,16 +36,16 @@ template metaprogramming in C++.
make install #only if you want to install the software after build
````

* The options -DINSTALLDIR_LEMONADE and -DBUILDDIR for the configure script are
optional. The build directory defaults to ./build, the install directory defaults
to /usr/local/ . The same goes for the option -DINSTALLDIR_LEMONADE when invoking
* The options `-DINSTALLDIR_LEMONADE` and `-DBUILDDIR` for the configure script are
optional. The build directory defaults to `./build`, the install directory defaults
to `/usr/local/` . The same goes for the option `-DINSTALLDIR_LEMONADE` when invoking
cmake (the second compilation and installation way).
* When installing using 'make install', the library is installed to
/given/installation/path/lib/LeMonADE/, or if no path was specified to
/usr/local/lib/LeMonADE/. Similar for the header files, which go to
/given/installation/path/include/LeMonADE/ or /usr/local/include/LeMonADE/.
* When installing using `make install`, the library is installed to
`/given/installation/path/lib/LeMonADE/`, or if no path was specified to
`/usr/local/lib/LeMonADE/`. Similar for the header files, which go to
`/given/installation/path/include/LeMonADE/` or `/usr/local/include/LeMonADE/`.
* For uninstalling simply remove the files created in the installation step.
* If you do not specify the install directory, and the default /usr/local/ is used,
* If you do not specify the install directory, and the default `/usr/local/` is used,
you need root access when installing. In this case

````sh
Expand All @@ -54,9 +54,9 @@ template metaprogramming in C++.
````
* If you also want to compile and run the tests, there is another option, which can be
passed to either the configure script (first build method), or to cmake (second build method)
This option is -DLEMONADE_TESTS=ON . You need internet access, because the process will
This option is `-DLEMONADE_TESTS=ON` . You need internet access, because the process will
download the googletest library
* Another option that can be passed is -DCMAKE_BUILD_TYPE=Release/Debug. The default value
* Another option that can be passed is `-DCMAKE_BUILD_TYPE=Release/Debug`. The default value
is Release, which uses compiler flags for optimization. If the option "Debug" is chosen,
no compiler optimizations are used, compiler warnings are enabled by -Wall, and
debugging information is compiled into the binary with -g. Other flags then "Release",
Expand All @@ -78,6 +78,7 @@ This can be found in the documentation.
make docs
````

or

```sh
# generates the docs
Expand All @@ -90,23 +91,28 @@ This can be found in the documentation.

## Contributions

* Any contributions making the programm better are welcome
* Any contributions/suggestions making the program become better are welcome
* Every contribution should be made by following the guidelines made by the [gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)


## Authors

Find the information about active developers, former contributors and people who contributed in the [AUTHORS](AUTHORS.md) file.
Find the information about active developers, former contributors, and people who contributed in the [AUTHORS](AUTHORS.md) file.

## References

This library has been used in the following publications (without guarantee for completeness)
* C. Jentzsch, J.-U. Sommer; [J. Chem. Phys. 10, 104908 (2014)](http://dx.doi.org/10.1063/1.4895555)
* H. Rabbel, M. Werner, J.-U. Sommer; [Macromolecules 48, 4724-4732 (2015)](http://dx.doi.org/10.1021/acs.macromol.5b00720)
* M. Lang, M. Werner, R. Dockhorn, T. Kreer; [Macromolecules 49, 5190-5201 (2016)](http://dx.doi.org/10.1021/acs.macromol.6b00761)
* M. Wengenmayr, R. Dockhorn, J.-U. Sommer; [Macromolecules 49, 9215-9227 (2016)](http://dx.doi.org/10.1021/acs.macromol.6b01712)
* C. Jentzsch, R. Dockhorn, J.-U. Sommer; [Parallel Processing and Applied Mathematics. Lecture Notes in Computer Science, vol 9574. pp 301-311 (2016)](http://dx.doi.org/10.1007/978-3-319-32152-3_28)
* M. Wengenmayr, R. Dockhorn, J.-U. Sommer; [Macromolecules 52, 2616–2626 (2019)](https://doi.org/10.1021/acs.macromol.9b00010)
* *"Polyolefins Formed by Chain Walking Catalysis—A Matter of Branching Density Only?"*; R. Dockhorn, L. Pl&uuml;schke, M. Geisler, J. Zessin, P. Lindner, R. Mundil, J. Merna, J.-U. Sommer, A. Lederer; [J. Am. Chem. Soc. 141, 15586–15596 (2019)](https://pubs.acs.org/doi/10.1021/jacs.9b06785)
* *"Tendomers – force sensitive bis-rotaxanes with jump-like deformation behavior"*; T. M&uuml;ller, J.-U. Sommer, M. Lang; [Soft Matter, 15, 3671-3679 (2019)](https://doi.org/10.1039/C9SM00292H)
* *"Dendrimers in Solution of Linear Polymers: Crowding Effects"*; M. Wengenmayr, R. Dockhorn, J.-U. Sommer; [Macromolecules 52, 2616–2626 (2019)](https://doi.org/10.1021/acs.macromol.9b00010)
* *"Testing the physics of knots with a Feringa nanoengine"*; M. Lang, C. Schuster, R. Dockhorn, M. Wengenmayr, J.-U. Sommer; [Phys. Rev. E 98, 052501 (2018)](https://doi.org/10.1103/PhysRevE.98.052501)
* *"Formation and stabilization of pores in bilayer membranes by peptide-like amphiphilic polymers"*; A. Checkervarty, M. Werner and J.-U. Sommer; [Soft Matter 14, 2526-2534 (2018)](https://doi.org/10.1039/C7SM02404E)
* *"Swelling Behavior of Single-Chain Polymer Nanoparticles: Theory and Simulation"*; H. Rabbel, P. Breier, J.-U. Sommer; [Macromolecules 50, 7410–7418 (2017)](https://doi.org/10.1021/acs.macromol.7b01379)
* *"A Highly Parallelizable Bond Fluctuation Model on the Body-Centered Cubic Lattice"*; C. Jentzsch, R. Dockhorn, J.-U. Sommer; [Parallel Processing and Applied Mathematics. Lecture Notes in Computer Science, vol 9574. pp 301-311 (2016)](http://dx.doi.org/10.1007/978-3-319-32152-3_28)
* *"Multicore Unimolecular Structure Formation in Single Dendritic–Linear Copolymers under Selective Solvent Conditions"*; M. Wengenmayr, R. Dockhorn, J.-U. Sommer; [Macromolecules 49, 9215-9227 (2016)](http://dx.doi.org/10.1021/acs.macromol.6b01712)
* *"Interactions of Amphiphilic Triblock Copolymers with Lipid Membranes: Modes of Interaction and Effect on Permeability Examined by Generic Monte Carlo Simulations"*; H. Rabbel, M. Werner, J.-U. Sommer; [Macromolecules 48, 4724-4732 (2015)](http://dx.doi.org/10.1021/acs.macromol.5b00720)
* *"Polymer brushes in explicit poor solvents studied using a new variant of the bond fluctuation model"*; C. Jentzsch, J.-U. Sommer; [J. Chem. Phys. 10, 104908 (2014)](http://dx.doi.org/10.1063/1.4895555)


## License

Expand Down

0 comments on commit d16ef40

Please sign in to comment.