Skip to content

Commit

Permalink
update license to L-GPL and add user_doc/Maze.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jakryd committed Apr 6, 2019
1 parent a1598c4 commit 92dccf8
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions user-doc/Maze.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
\page maze

<!--
description: Module that implements enhanced sampling methods for ligand
unbinding from protein tunnels.
authors: Jakub Rydzewski
reference: J. Rydzewski, and O. Valsson, Finding Multiple Reaction Pathways of
Ligand Unbinding, arXiv: 1808.08089, 2018
-->

maze is a module for PLUMED2, which implements enhanced sampling methods for
ligand unbinding from protein tunnels. The maze module is developed and
maintained by [Jakub Rydzewski](http://www.fizyka.umk.pl/~jr) at the Institute
of Physics, Nicolaus Copernicus University, Toruń, Poland. See this
[link](https://www.fizyka.umk.pl/~jr/maze.html) for additional information.

The maze module is an optional module for PLUMED2 that needes to be enabled when
configuring the compilation of PLUMED2. You can either pass a flag
'\-\-enable-modules=maze' or a '\-\-enable-modules=all' when running the
configure script.

See the following sections for further information:

- \subpage maze_loss
- \subpage maze_optimizer
- \subpage maze_bias

\page maze_loss Loss

The following list contains the loss functions available in the maze module.

@MAZE_LOSS@

\page maze_optimizer Optimizers

The following list contains the optimizers available in the maze module.

@MAZE_OPTIMIZER@

\page maze_bias Biases

The following list contains the biases available in the maze module.

@MAZE_BIAS@

0 comments on commit 92dccf8

Please sign in to comment.