Skip to content

Commit

Permalink
Added module names to summary and tried to fix docs for EnvironmentSi…
Browse files Browse the repository at this point in the history
…milarity
  • Loading branch information
Gareth Aneurin Tribello authored and Gareth Aneurin Tribello committed Oct 27, 2024
1 parent 8bc9266 commit 861b0b7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 14 deletions.
12 changes: 6 additions & 6 deletions new-manual/summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ __List of actions that have broken examples__
There are {{ failed.size }} action pages with failing inputs.

{:#browse-table .display}
| Name | # fails |
|:----:|:-------:|
{% for item in failed %} | [{{ item.name }}]( {{ item.path }}) | {{ item.nfail }} |
| Name | Module | # fails |
|:----:|:-------:|:-------:|
{% for item in failed %} | [{{ item.name }}]( {{ item.path }}) | {{ item.module }} | {{ item.nfail }} |
{% endfor %}

__List of actions that have no examples in manual__

There are {{ noexamples.size }} action pages with no examples.

{:#browse-table .display}
| Name | # fails |
|:----:|:-------:|
{% for item in noexamples %} | [{{ item.name }}]( {{ item.path }}) | {{ item.nfail }} |
| Name | Module | # fails |
|:----:|:-------:|:-------:|
{% for item in noexamples %} | [{{ item.name }}]( {{ item.path }}) | {{ item.module }} | {{ item.nfail }} |
{% endfor %}
17 changes: 9 additions & 8 deletions src/envsim/EnvironmentSimilarity.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -125,11 +125,12 @@ environment. The reference environment is contained in the env1.pdb file. Once t
the average and the number of atoms with a kernel larger than 0.5 are computed.
```plumed
#SETTINGS INPUTFILES=regtest/envsim/rt-env-sim-atom-names-match/env1.pdb
ENVIRONMENTSIMILARITY ...
SPECIES=1-288:3
SIGMA=0.05
CRYSTAL_STRUCTURE=CUSTOM
REFERENCE=env1.pdb
REFERENCE=regtest/envsim/rt-env-sim-atom-names-match/env1.pdb
LABEL=es
MEAN
MORE_THAN={RATIONAL R_0=0.5 NN=12 MM=24}
Expand All @@ -147,10 +148,10 @@ ENVIRONMENTSIMILARITY ...
SPECIES=1-288:3
SIGMA=0.05
CRYSTAL_STRUCTURE=CUSTOM
REFERENCE_1=env1.pdb
REFERENCE_2=env2.pdb
REFERENCE_3=env3.pdb
REFERENCE_4=env4.pdb
REFERENCE_1=regtest/envsim/rt-env-sim-atom-names-match/env1.pdb
REFERENCE_2=regtest/envsim/rt-env-sim-atom-names-match/env2.pdb
REFERENCE_3=regtest/envsim/rt-env-sim-atom-names-match/env3.pdb
REFERENCE_4=regtest/envsim/rt-env-sim-atom-names-match/env4.pdb
LABEL=es
MEAN
MORE_THAN={RATIONAL R_0=0.5 NN=12 MM=24}
Expand All @@ -164,15 +165,15 @@ The following examples illustrates the use of pdb files to provide information a
```plumed
ENVIRONMENTSIMILARITY ...
#SETTINGS INPUTFILES=regtest/envsim/rt-env-sim-custom-1env/env1.pdb,regtest/envsim/rt-env-sim-custom-1env/IceIh-atom-names.pdb
#SETTINGS INPUTFILES=regtest/envsim/rt-env-sim-custom-1env/env1.pdb,regtest/envsim/rt-env-sim-atom-names-match/IceIh-atom-names.pdb
SPECIES=1-6
SIGMA=0.05
CRYSTAL_STRUCTURE=CUSTOM
REFERENCE=env1.pdb
REFERENCE=regtest/envsim/rt-env-sim-custom-1env/env1.pdb
LABEL=es
MEAN
MORE_THAN={RATIONAL R_0=0.5 NN=12 MM=24}
ATOM_NAMES_FILE=regtest/envsim/rt-env-sim-custom-1env/IceIh-atom-names.pdb
ATOM_NAMES_FILE=regtest/envsim/rt-env-sim-atom-names-match/IceIh-atom-names.pdb
... ENVIRONMENTSIMILARITY
```
Expand Down

1 comment on commit 861b0b7

@PlumedBot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found broken examples in automatic/ANN.tmp
Found broken examples in automatic/CAVITY.tmp
Found broken examples in automatic/CLASSICAL_MDS.tmp
Found broken examples in automatic/CONSTANT.tmp
Found broken examples in automatic/CONVERT_TO_FES.tmp
Found broken examples in automatic/COORDINATIONNUMBER.tmp
Found broken examples in automatic/DISTANCE_FROM_CONTOUR.tmp
Found broken examples in automatic/DUMPCUBE.tmp
Found broken examples in automatic/DUMPGRID.tmp
Found broken examples in automatic/EDS.tmp
Found broken examples in automatic/EMMI.tmp
Found broken examples in automatic/FIND_CONTOUR.tmp
Found broken examples in automatic/FIND_CONTOUR_SURFACE.tmp
Found broken examples in automatic/FIND_SPHERICAL_CONTOUR.tmp
Found broken examples in automatic/FOURIER_TRANSFORM.tmp
Found broken examples in automatic/FUNCPATHGENERAL.tmp
Found broken examples in automatic/FUNCPATHMSD.tmp
Found broken examples in automatic/FUNNEL.tmp
Found broken examples in automatic/FUNNEL_PS.tmp
Found broken examples in automatic/GHBFIX.tmp
Found broken examples in automatic/GPROPERTYMAP.tmp
Found broken examples in automatic/HISTOGRAM.tmp
Found broken examples in automatic/INCLUDE.tmp
Found broken examples in automatic/INCYLINDER.tmp
Found broken examples in automatic/INENVELOPE.tmp
Found broken examples in automatic/INTERPOLATE_GRID.tmp
Found broken examples in automatic/LOCAL_AVERAGE.tmp
Found broken examples in automatic/MAZE_OPTIMIZER_BIAS.tmp
Found broken examples in automatic/MAZE_RANDOM_ACCELERATION_MD.tmp
Found broken examples in automatic/MAZE_SIMULATED_ANNEALING.tmp
Found broken examples in automatic/MAZE_STEERED_MD.tmp
Found broken examples in automatic/METATENSOR.tmp
Found broken examples in automatic/MULTICOLVARDENS.tmp
Found broken examples in automatic/PAMM.tmp
Found broken examples in automatic/PCA.tmp
Found broken examples in automatic/PCAVARS.tmp
Found broken examples in automatic/PIV.tmp
Found broken examples in automatic/PLUMED.tmp
Found broken examples in automatic/PYCVINTERFACE.tmp
Found broken examples in automatic/PYTHONFUNCTION.tmp
Found broken examples in automatic/Q3.tmp
Found broken examples in automatic/Q4.tmp
Found broken examples in automatic/Q6.tmp
Found broken examples in automatic/QUATERNION.tmp
Found broken examples in automatic/REWEIGHT_BIAS.tmp
Found broken examples in automatic/REWEIGHT_METAD.tmp
Found broken examples in automatic/SIZESHAPE_POSITION_LINEAR_PROJ.tmp
Found broken examples in automatic/SIZESHAPE_POSITION_MAHA_DIST.tmp
Found broken examples in automatic/TETRAHEDRALPORE.tmp
Found broken examples in automatic/WHAM_HISTOGRAM.tmp
Found broken examples in automatic/WHAM_WEIGHTS.tmp
Found broken examples in AnalysisPP.md
Found broken examples in CollectiveVariablesPP.md
Found broken examples in MiscelaneousPP.md

Please sign in to comment.